如何重置Redux存储的状态?


455

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

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

  1. 用户u1登录到应用程序并执行某项操作,因此我们在商店中缓存了一些数据。

  2. 用户u1注销。

  3. 用户u2无需刷新浏览器即可登录应用程序。

此时,缓存的数据将与关联u1,我想对其进行清理。

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


8
最好是注销时清除状态(从安全角度而言)
Clarkie

Answers:


1033

一种方法是在您的应用程序中编写根减少器。

根减速器通常会将处理操作委托给由生成的减速器combineReducers()。但是,无论何时收到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操作后返回初始状态即可。众所周知,无论以什么方式进行操作,都应该在将reduce 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)
}

请注意,我这里不是在改变状态,我只是在重新分配一个称为state传递给另一个函数之前对其进行。更改状态对象将违反Redux原则。

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

首先,您需要导入适当的存储引擎,然后在将其设置为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);
};

15
我很好奇Dan,您能在减速器中做类似的事情吗?以CLEAR_DATA为动作。case 'CLEAR_DATA': return initialState
HussienK '16

6
@HussienK可以工作,但对于每个减速器都不会起作用。
科里·丹尼尔森

12
这是一个版本,可以在您使用异步减速器的情况下动态组合减速器:export const createRootReducer = asyncReducers => { const appReducer = combineReducers({ myReducer ...asyncReducers }); return (state, action) => { if (action.type === 'LOGOUT_USER') { state = undefined; } return appReducer(state, action); } };
Ivo Sabev,2016年

2
if (action.type === 'RESET') return action.stateFromLocalStorage
丹·阿布拉莫夫

3
这种方法是否可以彻底清除该州及其所有历史?我从安全角度考虑:如果已实施此USER_LOGOUT操作,则一旦触发该操作,是否有可能早日获取状态数据?(例如通过devtools)
AlexKempton

81

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

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

19
我认为这里的要点是您可能不想在注销时清除整个状态树-该方法在任何子树的根reducer上同样有效,因此将这种技术仅应用到子树的root reducer上可能更清楚。您确实想要清除的子树,而不是挑选“特殊的”子代而不清除整个树的根减速器,就像这样
davnicwil

1
我想我遇到了您现在所指的这个问题((在注销时它将把溃败设置为正确的路径,但会加载一个完整的不同组件)我实现了与您类似的解决方案,但我认为不可变的js正在将其大规模化。我最终创建了一个具有RESET-STATE动作的父级减速器,并且我从该减速器继承以避免完全接触路由
Neta Meta

遇到类似的问题,已解决。谢谢。
劳埃德·沃特金

3
请注意,使用react-redux-router时,该属性为routerand NOTrounting
Mrchief

2
@Mrchief,这取决于您在combineReducers().....中定义的内容(如果您具有combineReducers({routing: routingReducer})答案中所描述的内容)
Ben Lonsdale

39

定义一个动作:

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动作,reduce都会以默认状态更新商店。

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

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”。这样,商店注销和重置将同步进行,并且商店将准备好另一个用户登录。


1
我觉得这比将状态设置undefined为另一个答案更好。当您的应用程序期望状态树而您给它一个状态树时undefined,除了空树之外,还有更多的错误和麻烦要处理。
worc

3
@worc状态实际上不会是不确定的,因为化径器在收到未定义的状态时会返回initialState
Guillaume

3
@worc认为,使用这种方法,每次有人创建新的reducer时,您都必须记住要添加重设案例。
Francute

1
出于上述两个原因,加上RESET_ACTION是一个action的想法,我绝对改变了主意。因此从一开始它并不真正属于减速器。
worc

1
这绝对是正确的方法。将状态设置为除初始状态外的其他任何内容都只是在麻烦
Sebastian Serrano

15

只是最佳答案的简化答案:

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


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

谢谢,这是我的工作,我来自Dan的回答,但我无法弄清楚。
Aljohn Yamaro

14
 const reducer = (state = initialState, { type, payload }) => {

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

   return state
 }

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


10

使用Redux时,如果已应用以下解决方案,则假定我已在所有reducer中设置了initialState(例如{user:{name,email}})。在许多组件中,我都检查了这些嵌套属性,因此通过此修复程序,可以防止我的render方法在耦合的属性条件下损坏(例如,如果上面提到的解决方案未定义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)
}

7

更新NGRX4

如果您要迁移到NGRX 4,则可能已从迁移指南中注意到中用于合并化简的rootreducer方法已被ActionReducerMap方法替换。首先,这种新的工作方式可能会使重置状态成为一个挑战。实际上,这很简单,但是方法已经改变。

该解决方案的灵感来自于 NGRX4 Github文档。

首先,假设您正在使用NGRX的新ActionReducerMap选项来组合减速器:

//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达到相同效果的一种方法。


5

结合使用Dan,Ryan和Rob的方法来说明保持router状态并初始化状态树中的所有其他内容,我最终得出以下结论:

const rootReducer = (state, action) => appReducer(action.type === LOGOUT ? {
    ...appReducer({}, {}),
    router: state && state.router || {}
  } : state, action);

4

我已经创建了一个组件来赋予Redux重置状态的能力,您只需要使用此组件来增强您的商店并调度一个特定的action.type即可触发重置。实现的思想与@Dan Abramov所说的相同。

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


4

我创建了清除状态的动作。因此,当我分派注销操作创建者时,我也会分派操作以清除状态。

用户记录动作

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的答案对这个问题给出了一个很好的主意,但由于我正在使用,因此对我来说效果不佳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

以下解决方案为我工作。

我在meta reducers中添加了重置状态功能,关键是要使用

return reducer(undefined, action);

将所有减速器设置为初始状态。归来undefined相反,由于商店的结构已被破坏,因此会导致错误。

/reducers/index.ts

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 {}

2

从安全的角度看,最安全的事情时,将用户登录了是将所有持久状态(如饼干,localStorageIndexedDBWeb SQL,等)和使用做网页的硬刷新window.location.reload()。可能是一个草率的开发人员意外地或有意地将某些敏感数据存储window在,DOM中等上。吹散所有持久状态并刷新浏览器是唯一保证不将前一个用户的信息泄露给下一个用户的方法。

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


1
为什么人们对此表示反对?当您使用空内容执行新的redux状态时,基本上您仍会在内存中保留以前的状态,并且从理论上讲您可以从中访问数据。刷新浏览器是您最安全的选择!
威廉·索尔班

2

我使用基于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"})
  }
}

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;

希望这对其他人有帮助:)


如果我有10个以上的状态,但只想重置一个减速器的状态怎么办?
保罗

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

一个对我有用的快速简便的选择是使用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'
})

希望这可以帮助


1

我采取的措施是防止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;
  }
};

将默认状态写为函数的想法在这里确实节省了一天。谢谢🙏
克里斯-保罗

0

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

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

如果只需要重置状态树的一部分,则还可以USER_LOGOUT在该reducer中进行监听并在那里进行处理。
Andy_D

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;
}

注意:确保将操作默认值设置为,{}并且可以,因为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)
}

0

除了Dan Abramov的答案之外,我们不应该在state = undefined旁边将action明确设置为action = {type:'@@ INIT'}。使用上述动作类型,每个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

以下解决方案对我有效。

首先在开始我们的应用程序的减速状态是新鲜的新的默认的初始化状态

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

虽然应用程序的注销,我们可以简单的重新分配默认状态和减速机的工作只是为

主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

可接受答案中的解决方案不做的一件事是清除参数化选择器的缓存。如果您有这样的选择器:

export const selectCounter1 = (state: State) => state.counter1;
export const selectCounter2 = (state: State) => state.counter2;
export const selectTotal = createSelector(
  selectCounter1,
  selectCounter2,
  (counter1, counter2) => counter1 + counter2
);

然后,您必须在注销时释放它们,如下所示:

selectTotal.release();

否则,选择器最后一次调用的记忆值和最后一个参数的值仍将保留在内存中。

代码示例来自ngrx docs


0

对我来说,最好的方法是设置initialState而不是state

  const reducer = createReducer(initialState,
  on(proofActions.cleanAdditionalInsuredState, (state, action) => ({
    ...initialState
  })),

-1

另一种选择是:

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

'@@redux/INIT'是redux在您执行时自动调度的操作类型createStore,因此,假设您的化合器已经具有默认值,那么它将被这些还原器捕获并重新开始您的状态。不过,它可能被认为是re​​dux的私有实现细节,因此买方请注意...


我做到了这并没有改变状态,我也尝试了@@ INIT,这在ReduxDevtools中显示为第一个动作
Reza

-3

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


1
如果您使用将商店同步到本地存储的中间件怎么办?那么您的方法根本行不通……
Spock

8
我真的不明白为什么人们会否决这样的答案。
威廉·贾德

人们为什么对此表示反对?当您使用空内容执行新的redux状态时,基本上您仍会在内存中保留以前的状态,并且从理论上讲您可以从中访问数据。刷新浏览器是您最安全的选择!
Wilhelm Sorban '18

-3

onLogout() {
  this.props.history.push('/login'); // send user to login page
  window.location.reload(); // refresh the page
}


说明?@SinanSamet
Nikita Beznosikov '19

明确地说,我没有对此投反对票。但我不鼓励这样做。如果导航至登录并重新加载,则可能会注销。但这仅仅是因为您失去了状态。除非您使用redux-persist,否则您甚至都不会注销。总体来说,我只是不愿意看到的功能,如window.location.reload();
思南沙美

-不要编写这样的函数。-为什么?我不喜欢
Nikita Beznosikov,

1
重新加载页面与重置存储状态不同。此外,你可能会在环境中没有window,如反应母语
马克斯
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.