如何重置Redux商店的状态?

问题描述 投票:332回答:27

我正在使用Redux进行状态管理。 如何将商店重置为初始状态?

例如,假设我有两个用户帐户(u1u2)。 想象一下以下一系列事件:

  1. 用户u1登录到应用程序并执行某些操作,因此我们在商店中缓存一些数据。
  2. 用户u1退出。
  3. 用户u2登录应用程序而不刷新浏览器。

此时,缓存的数据将与u1关联,我想清理它。

当第一个用户注销时,如何将Redux存储重置为其初始状态?

javascript redux store redux-store
27个回答
829
投票

一种方法是在应用程序中编写根reducer。

根减速器通常会将操作委托给combineReducers()生成的reducer。但是,无论何时收到USER_LOGOUT动作,它都会重新返回初始状态。

例如,如果您的根减速器看起来像这样:

const rootReducer = combineReducers({
  /* your app’s top-level reducers */
})

您可以将其重命名为appReducer并写一个新的rootReducer委托给它:

const appReducer = combineReducers({
  /* your app’s top-level reducers */
})

const rootReducer = (state, action) => {
  return appReducer(state, action)
}

现在我们只需要教导新的rootReducerUSER_LOGOUT动作之后返回初始状态。众所周知,无论动作如何,当undefined作为第一个参数调用时,减速器应该返回初始状态。让我们用这个事实有条件地剥离累积的state,因为我们将它传递给appReducer

 const rootReducer = (state, action) => {
  if (action.type === 'USER_LOGOUT') {
    state = undefined
  }

  return appReducer(state, action)
}

现在,每当USER_LOGOUT发射时,所有减速器都将重新初始化。他们也可以返回与他们最初不同的东西,因为他们也可以检查action.type

重申一下,全新代码如下所示:

const appReducer = combineReducers({
  /* your app’s top-level reducers */
})

const rootReducer = (state, action) => {
  if (action.type === 'USER_LOGOUT') {
    state = undefined
  }

  return appReducer(state, action)
}

请注意,我不是在这里改变状态,在传递给另一个函数之前,我只是一个名为reassigning the reference的局部变量的state。改变状态对象将违反Redux原则。

如果您使用的是redux-persist,您可能还需要清理存储空间。 Redux-persist会在存储引擎中保留您的状态副本,并在刷新时从那里加载状态副本。

首先,您需要导入适当的storage engine,然后在将其设置为undefined之前解析状态并清理每个存储状态键。

const rootReducer = (state, action) => {
    if (action.type === SIGNOUT_REQUEST) {
        // for all keys defined in your persistConfig(s)
        storage.removeItem('persist:root')
        // storage.removeItem('persist:otherKey')

        state = undefined;
    }
    return appReducer(state, action);
};

3
投票

我已经创建了清除状态的动作。因此,当我发送一个注销动作创建者时,我也会调度动作来清除状态。

用户记录操作

export const clearUserRecord = () => ({
  type: CLEAR_USER_RECORD
});

注销动作创建者

export const logoutUser = () => {
  return dispatch => {
    dispatch(requestLogout())
    dispatch(receiveLogout())
    localStorage.removeItem('auth_token')
    dispatch({ type: 'CLEAR_USER_RECORD' })
  }
};

减速器

const userRecords = (state = {isFetching: false,
  userRecord: [], message: ''}, action) => {
  switch (action.type) {
    case REQUEST_USER_RECORD:
    return { ...state,
      isFetching: true}
    case RECEIVE_USER_RECORD:
    return { ...state,
      isFetching: false,
      userRecord: action.user_record}
    case USER_RECORD_ERROR:
    return { ...state,
      isFetching: false,
      message: action.message}
    case CLEAR_USER_RECORD:
    return {...state,
      isFetching: false,
      message: '',
      userRecord: []}
    default:
      return state
  }
};

我不确定这是否是最佳的?


2
投票

如果你正在使用redux-actions,这里是一个使用HOF(高阶函数)为handleActions快速解决方法。

import { handleActions } from 'redux-actions';

export function handleActionsEx(reducer, initialState) {
  const enhancedReducer = {
    ...reducer,
    RESET: () => initialState
  };
  return handleActions(enhancedReducer, initialState);
}

然后使用handleActionsEx而不是原始的handleActions来处理减速器。

Dan's answer对这个问题提出了一个很好的想法,但它对我来说效果不佳,因为我正在使用redux-persist。 当与redux-persist一起使用时,简单地传递undefined状态并不会触发持久行为,所以我知道我必须手动从存储中删除项目(在我的情况下是React Native,因此AsyncStorage)。

await AsyncStorage.removeItem('persist:root');

要么

await persistor.flush(); // or await persistor.purge();

也不适合我 - 他们只是对我大吼大叫。 (例如,抱怨像“意外的关键_persist ......”)

然后我突然思考所有我想要的只是让每个减速器在遇到RESET动作类型时返回自己的初始状态。这样,坚持自然处理。显然没有上面的实用功能(handleActionsEx),我的代码看起来不会干(虽然它只是一个衬垫,即RESET: () => initialState),但我无法忍受它'因为我喜欢元编程。


2
投票

接受的答案帮助我解决了我的问题。但是,我遇到了必须清除不是整个州的情况。所以 - 我这样做了:

const combinedReducer = combineReducers({
    // my reducers 
});

const rootReducer = (state, action) => {
    if (action.type === RESET_REDUX_STATE) {
        // clear everything but keep the stuff we want to be preserved ..
        delete state.something;
        delete state.anotherThing;
    }
    return combinedReducer(state, action);
}

export default rootReducer;

希望这有助于别人:)


1
投票

只是对@dan-abramov答案的延伸,有时我们可能需要保留某些键才能被重置。

const retainKeys = ['appConfig'];

const rootReducer = (state, action) => {
  if (action.type === 'LOGOUT_USER_SUCCESS' && state) {
    state = !isEmpty(retainKeys) ? pick(state, retainKeys) : undefined;
  }

  return appReducer(state, action);
};

1
投票

以下解决方案对我有用。

我添加了重置状态函数到meta redurs。关键是使用

return reducer(undefined, action);

将所有Reducer设置为初始状态。由于商店的结构已被破坏,因此返回undefined导致错误。

/reducers/index.同时

export function resetState(reducer: ActionReducer<State>): ActionReducer<State> {
  return function (state: State, action: Action): State {

    switch (action.type) {
      case AuthActionTypes.Logout: {
        return reducer(undefined, action);
      }
      default: {
        return reducer(state, action);
      }
    }
  };
}

export const metaReducers: MetaReducer<State>[] = [ resetState ];

app.module.ts

import { StoreModule } from '@ngrx/store';
import { metaReducers, reducers } from './reducers';

@NgModule({
  imports: [
    StoreModule.forRoot(reducers, { metaReducers })
  ]
})
export class AppModule {}

1
投票

从安全角度来看,记录用户时最安全的做法是重置所有持久状态(e.x.cookie,localStorageIndexedDBWeb SQL等)并使用window.location.reload()对页面进行硬刷新。一个草率的开发人员可能会意外地或有意地将一些敏感数据存储在window,DOM等中。吹掉所有持久状态并刷新浏览器是保证以前用户的信息不会泄露给下一个用户的唯一方法。

(当然,作为共享计算机上的用户,您应该使用“隐私浏览”模式,自己关闭浏览器窗口,使用“清除浏览数据”功能等,但作为开发人员,我们不能指望每个人都是勤奋)


1
投票

对我有用的快速简便的选择是使用redux-reset。对于较大的应用程序,这是直截了当的,并且还有一些高级选项。

在创建商店中设置

import reduxReset from 'redux-reset'
...
const enHanceCreateStore = compose(
applyMiddleware(...),
reduxReset()  // Will use 'RESET' as default action.type to trigger reset
)(createStore)
const store = enHanceCreateStore(reducers)

在您的注销功能中发送“重置”

store.dispatch({
type: 'RESET'
})

希望这可以帮助


0
投票

这种方法非常正确:破坏任何特定状态“NAME”以忽略并保留其他状态。

const rootReducer = (state, action) => {
    if (action.type === 'USER_LOGOUT') {
        state.NAME = undefined
    }
    return appReducer(state, action)
}

0
投票

你为什么不用return module.exports.default();)

export default (state = {pending: false, error: null}, action = {}) => {
    switch (action.type) {
        case "RESET_POST":
            return module.exports.default();
        case "SEND_POST_PENDING":
            return {...state, pending: true, error: null};
        // ....
    }
    return state;
}

注意:确保将操作默认值设置为{}并且您没问题,因为您在switch语句中检查action.type时不希望遇到错误。


0
投票

我发现接受的答案适合我,但它引发了ESLint no-param-reassign错误 - https://eslint.org/docs/rules/no-param-reassign

这是我如何处理它,确保创建一个状态的副本(根据我的理解,这是要做的Reduxy的事情......):

import { combineReducers } from "redux"
import { routerReducer } from "react-router-redux"
import ws from "reducers/ws"
import session from "reducers/session"
import app from "reducers/app"

const appReducer = combineReducers({
    "routing": routerReducer,
    ws,
    session,
    app
})

export default (state, action) => {
    const stateCopy = action.type === "LOGOUT" ? undefined : { ...state }
    return appReducer(stateCopy, action)
}

但也许创建一个状态的副本,只是将它传递给另一个reducer函数,创建一个副本,有点过于复杂?这看起来不太好,但更重要的是:

export default (state, action) => {
    return appReducer(action.type === "LOGOUT" ? undefined : state, action)
}

74
投票

我想指出Dan Abramov接受的评论是正确的,除非我们在使用react-router-redux软件包以及这种方法时遇到了一个奇怪的问题。我们的解决方法是不将状态设置为undefined,而是仍然使用当前的路由减少器。因此,如果您使用此软件包,我建议您实施以下解决方案

const rootReducer = (state, action) => {
  if (action.type === 'USER_LOGOUT') {
    const { routing } = state
    state = { routing } 
  }
  return appReducer(state, action)
}

0
投票

我在使用打字稿时的解决方法,建立在Dan的答案之上(redux打字使得无法将undefined作为第一个参数传递给reducer,所以我将初始根状态缓存在常量中):

// store

export const store: Store<IStoreState> = createStore(
  rootReducer,
  storeEnhacer,
)

export const initialRootState = {
  ...store.getState(),
}

// root reducer

const appReducer = combineReducers<IStoreState>(reducers)

export const rootReducer = (state: IStoreState, action: IAction<any>) => {
  if (action.type === "USER_LOGOUT") {
    return appReducer(initialRootState, action)
  }

  return appReducer(state, action)
}


// auth service

class Auth {
  ...

  logout() {
    store.dispatch({type: "USER_LOGOUT"})
  }
}

0
投票

除了Dan Abramov的答案之外,我们不应该明确将行动设置为action = {type:'@@ INIT'}以及state = undefined。使用上述操作类型,每个reducer返回初始状态。


0
投票

在服务器中,我有一个变量是:global.isSsr = true,在每个reducer中,我有一个const是:initialState要重置Store中的数据,我对每个Reducer执行以下操作:appReducer.js示例:

 const initialState = {
    auth: {},
    theme: {},
    sidebar: {},
    lsFanpage: {},
    lsChatApp: {},
    appSelected: {},
};

export default function (state = initialState, action) {
    if (typeof isSsr!=="undefined" && isSsr) { //<== using global.isSsr = true
        state = {...initialState};//<= important "will reset the data every time there is a request from the client to the server"
    }
    switch (action.type) {
        //...other code case here
        default: {
            return state;
        }
    }
}

终于在服务器的路由器上:

router.get('*', (req, res) => {
        store.dispatch({type:'reset-all-blabla'});//<= unlike any action.type // i use Math.random()
        // code ....render ssr here
});

0
投票

以下解决方案适合我。

首先在启动我们的应用程序时,reducer状态是全新的,具有默认的InitialState。

我们必须添加一个调用APP初始加载的操作来保持默认状态。

在退出应用程序时,我们可以简单地重新分配默认状态,而reducer也可以像新的一样工作。

主要APP容器

  componentDidMount() {   
    this.props.persistReducerState();
  }

主APP减速机

const appReducer = combineReducers({
  user: userStatusReducer,     
  analysis: analysisReducer,
  incentives: incentivesReducer
});

let defaultState = null;
export default (state, action) => {
  switch (action.type) {
    case appActions.ON_APP_LOAD:
      defaultState = defaultState || state;
      break;
    case userLoginActions.USER_LOGOUT:
      state = defaultState;
      return state;
    default:
      break;
  }
  return appReducer(state, action);
};

在注销调用操作以重置状态

function* logoutUser(action) {
  try {
    const response = yield call(UserLoginService.logout);
    yield put(LoginActions.logoutSuccess());
  } catch (error) {
    toast.error(error.message, {
      position: toast.POSITION.TOP_RIGHT
    });
  }
}

希望这能解决你的问题!


0
投票

为了让我将状态重置为初始状态,我编写了以下代码:

const appReducers = (state, action) =>
   combineReducers({ reducer1, reducer2, user })(
     action.type === "LOGOUT" ? undefined : state,
     action
);

0
投票

我希望Redux不要引用初始状态的相同变量:

// write the default state as a function
const defaultOptionsState = () => ({
  option1: '',
  option2: 42,
});

const initialState = {
  options: defaultOptionsState() // invoke it in your initial state
};

export default (state = initialState, action) => {

  switch (action.type) {

    case RESET_OPTIONS:
    return {
      ...state,
      options: defaultOptionsState() // invoke the default function to reset this part of the state
    };

    default:
    return state;
  }
};

-1
投票

另一种选择是:

store.dispatch({type: '@@redux/INIT'})

'@@redux/INIT'是当你使用createStore时redux自动调度的动作类型,所以假设你的减速器都已经有一个默认值,那么这将被这些人抓住并开始你的状态。它可能被认为是re​​dux的私有实现细节,所以买家要小心......


-7
投票

只需将您的注销链接清除会话并刷新页面即可。您的商店不需要其他代码。只要您想完全重置状态,页面刷新就是一种简单且易于重复的处理方式。


24
投票

定义一个动作:

const RESET_ACTION = {
  type: "RESET"
}

然后在每个减速器中假设您使用switchif-else来处理通过每个减速器的多个动作。我将以switch为例。

const INITIAL_STATE = {
  loggedIn: true
}

const randomReducer = (state=INITIAL_STATE, action) {
  switch(action.type) {
    case 'SOME_ACTION_TYPE':

       //do something with it

    case "RESET":

      return INITIAL_STATE; //Always return the initial state

   default: 
      return state; 
  }
}

这样,无论何时调用RESET动作,reducer都会以默认状态更新存储。

现在,对于注销,您可以处理以下内容:

const logoutHandler = () => {
    store.dispatch(RESET_ACTION)
    // Also the custom logic like for the rest of the logout handler
}

每次用户登录时,都不会刷新浏览器。商店将始终处于默认状态。

store.dispatch(RESET_ACTION)只是阐述了这个想法。您很可能会有一个动作创建者。一个更好的方法是你有一个LOGOUT_ACTION

一旦你派遣这个LOGOUT_ACTION。然后,自定义中间件可以使用Redux-Saga或Redux-Thunk拦截此操作。但是,无论如何,您都可以发送另一个动作'RESET'。这样,商店注销和重置将同步进行,您的商店将准备好进行其他用户登录。


11
投票
 const reducer = (state = initialState, { type, payload }) => {

   switch (type) {
      case RESET_STORE: {
        state = initialState
      }
        break
   }

   return state
 }

您还可以触发由要重置为初始存储的全部或部分缩减器处理的操作。一个动作可以触发重置到整个状态,或只是一个看起来适合你的状态。我相信这是最简单,最可控的方式。


8
投票

使用Redux if已应用以下解决方案,假设我已在所有reducers中设置了initialState(例如{user:{name,email}})。在许多组件中,我检查这些嵌套属性,因此使用此修复程序,我阻止我的渲染方法在耦合属性条件下被破坏(例如,如果上面提到的解决方案,则将引发错误用户的state.user.email未定义)。

const appReducer = combineReducers({
  tabs,
  user
})

const initialState = appReducer({}, {})

const rootReducer = (state, action) => {
  if (action.type === 'LOG_OUT') {
    state = initialState
  }

  return appReducer(state, action)
}

6
投票

只是简单回答最佳答案:

const rootReducer = combineReducers({
    auth: authReducer,
    ...formReducers,
    routing
});


export default (state, action) => (
    action.type === 'USER_LOGOUT'
        ? rootReducer(undefined, action)
        : rootReducer(state, action)
)

5
投票

更新NGRX4

如果要迁移到NGRX 4,您可能已经注意到migration guide用于组合reducers的rootreducer方法已被ActionReducerMap方法替换。起初,这种新的做事方式可能会使重置状态成为挑战。它实际上是直截了当的,但这样做的方式已经改变了。

此解决方案的灵感来自NGRX4 Github docs.的meta-reducers API部分

首先,假设您正在使用NGRX的新ActionReducerMap选项组合您的Reducer:

//index.reducer.ts
export const reducers: ActionReducerMap<State> = {
    auth: fromAuth.reducer,
    layout: fromLayout.reducer,
    users: fromUsers.reducer,
    networks: fromNetworks.reducer,
    routingDisplay: fromRoutingDisplay.reducer,
    routing: fromRouting.reducer,
    routes: fromRoutes.reducer,
    routesFilter: fromRoutesFilter.reducer,
    params: fromParams.reducer
}

现在,假设您要从app.module中重置状态

//app.module.ts
import { IndexReducer } from './index.reducer';
import { StoreModule, ActionReducer, MetaReducer } from '@ngrx/store';
...
export function debug(reducer: ActionReducer<any>): ActionReducer<any> {
    return function(state, action) {

      switch (action.type) {
          case fromAuth.LOGOUT:
            console.log("logout action");
            state = undefined;
      }

      return reducer(state, action);
    }
  }

  export const metaReducers: MetaReducer<any>[] = [debug];

  @NgModule({
    imports: [
        ...
        StoreModule.forRoot(reducers, { metaReducers}),
        ...
    ]
})

export class AppModule { }

`

这基本上是与NGRX 4实现相同效果的一种方法。


4
投票

我已经创建了一个组件来为Redux提供重置状态的能力,你只需要使用这个组件来增强你的存储并调度一个特定的action.type来触发重置。实施的想法与@Dan Abramov所说的相同。

Github:https://github.com/wwayne/redux-reset


4
投票

结合Dan,Ryan和Rob的方法,考虑保持router状态并初始化状态树中的其他所有内容,我最终得到了:

const rootReducer = (state, action) => appReducer(action.type === LOGOUT ? {
    ...appReducer({}, {}),
    router: state && state.router || {}
  } : state, action);
© www.soinside.com 2019 - 2024. All rights reserved.