code-structure
Getting StartedTutorialAPIFAQBest PracticesGitHubNeed help?
🌜
🌞
Search
Redux FAQ: Code Structure#
Table of Contents#
What should my file structure look like? How should I group my action creators and reducers in my project? Where should my selectors go?#
Since Redux is just a data store library, it has no direct opinion on how your project should be structured. However, there are a few common patterns that most Redux developers tend to use:
Rails-style: separate folders for “actions”, “constants”, “reducers”, “containers”, and “components”
"Feature folders" / "Domain"-style : separate folders per feature or domain, possibly with sub-folders per file type
“Ducks/Slices”: similar to domain style, but explicitly tying together actions and reducers, often by defining them in the same file
It's generally suggested that selectors are defined alongside reducers and exported, and then reused elsewhere (such as in mapStateToProps functions, in async action creators, or sagas) to colocate all the code that knows about the actual shape of the state tree in the reducer files.
tip
We specifically recommend organizing your logic into "feature folders", with all the Redux logic for a given feature in a single "slice/ducks" file".
See this section for an example:
Detailed Explanation: Example Folder Structure
An example folder structure might look something like:
/srcindex.tsx: Entry point file that renders the React component tree/appstore.ts: store setuprootReducer.ts: root reducer (optional)App.tsx: root React component
/common: hooks, generic components, utils, etc/features: contains all "feature folders"/todos: a single feature foldertodosSlice.ts: Redux reducer logic and associated actionsTodos.tsx: a React component
/app contains app-wide setup and layout that depends on all the other folders.
/common contains truly generic and reusable utilities and components.
/features has folders that contain all functionality related to a specific feature. In this example, todosSlice.ts is a "duck"-style file that contains a call to RTK's createSlice() function, and exports the slice reducer and action creators.
While it ultimately doesn't matter how you lay out your code on disk, it's important to remember that actions and reducers should not be considered in isolation. It's entirely possible (and encouraged) for a reducer defined in one folder to respond to an action defined in another folder.
Further information#
Documentation
Articles
How to Scale React Applications (accompanying talk: Scaling React Applications)
Discussions
How should I split my logic between reducers and action creators? Where should my “business logic” go?#
There's no single clear answer to exactly what pieces of logic should go in a reducer or an action creator. Some developers prefer to have “fat” action creators, with “thin” reducers that simply take the data in an action and blindly merge it into the corresponding state. Others try to emphasize keeping actions as small as possible, and minimize the usage of getState() in an action creator. (For purposes of this question, other async approaches such as sagas and observables fall in the "action creator" category.)
There are several potential benefits from putting more logic into your reducers. It's likely that the action types would be more semantic and more meaningful (such as "USER_UPDATED" instead of "SET_STATE"). In addition, having more logic in reducers means that more functionality will be affected by time travel debugging.
This comment sums up the dichotomy nicely:
Now, the problem is what to put in the action creator and what in the reducer, the choice between fat and thin action objects. If you put all the logic in the action creator, you end up with fat action objects that basically declare the updates to the state. Reducers become pure, dumb, add-this, remove that, update these functions. They will be easy to compose. But not much of your business logic will be there. If you put more logic in the reducer, you end up with nice, thin action objects, most of your data logic in one place, but your reducers are harder to compose since you might need info from other branches. You end up with large reducers or reducers that take additional arguments from higher up in the state.
tip
We recommend putting as much logic as possible into reducers. There are times when you may need some logic to help prepare what goes into the action, but reducers should do most of the work.
Further information#
Documentation
Articles
Discussions
Why should I use action creators?#
Redux does not require action creators. You are free to create actions in any way that is best for you, including simply passing an object literal to dispatch. Action creators emerged from the Flux architecture and have been adopted by the Redux community because they offer several benefits.
Action creators are more maintainable. Updates to an action can be made in one place and applied everywhere. All instances of an action are guaranteed to have the same shape and the same default values.
Action creators are testable. The correctness of an inline action must be verified manually. Like any function, tests for an action creator can be written once and run automatically.
Action creators are easier to document. The action creator's parameters enumerate the action's dependencies. And centralization of the action definition provides a convenient place for documentation comments. When actions are written inline, this information is harder to capture and communicate.
Action creators are a more powerful abstraction. Creating an action often involves transforming data or making AJAX requests. Action creators provide a uniform interface to this varied logic. This abstraction frees a component to dispatch an action without being complicated by the details of that action's creation.
Further information#
Articles
Discussions
Where should websockets and other persistent connections live?#
Middleware are the right place for persistent connections like websockets in a Redux app, for several reasons:
Middleware exist for the lifetime of the application
Like with the store itself, you probably only need a single instance of a given connection that the whole app can use
Middleware can see all dispatched actions and dispatch actions themselves. This means a middleware can take dispatched actions and turn those into messages sent over the websocket, and dispatch new actions when a message is received over the websocket.
A websocket connection instance isn't serializable, so it doesn't belong in the store state itself
See this example that shows how a socket middleware might dispatch and respond to Redux actions.
There's many existing middleware for websockets and other similar connections - see the link below.
Libraries
How can I use the Redux store in non-component files?#
There should only be a single Redux store per application. This makes it effectively a singleton in terms of the app architecture. When used with React, the store is injected into the components at runtime by rendering a <Provider store={store}> around the root <App> component, so only the application setup logic needs to import the store directly.
However, there may be times when other parts of the codebase need to interact with the store as well.
You should avoid importing the store directly into other codebase files. While it may work in some cases, that often ends up causing circular import dependency errors.
Some possible solutions are:
Write your store-dependent logic as a thunk, and then dispatch that thunk from a component
Pass along references to
dispatchfrom components as arguments the relevant functionsWrite the logic as middleware and add them to the store at setup time
Inject the store instance into the relevant files as the app is being created.
One common use case is reading API authorization information such as a token from the Redux state, inside of an Axios interceptor. The interceptor file needs to reference store.getState(), but also needs to be imported into API layer files, and this leads to circular imports.
You can expose an injectStore function from the interceptor file instead:
common/api.js
let store
export const injectStore(_store) {
store = _store
}
axiosInstance.interceptors.request.use(
config => {
config.headers.authorization = store.getState().auth.token
return config;
}
)
Copy
Then, in your entry point file, inject the store into the API setup file:
index.js
import store from "./app/store".
import {injectStore} from "./common/api";
injectStore(store);
Copy
This way, the application setup is the only code that has to import the store, and the file dependency graph avoids circular dependencies.
Previous
« Immutable Data
Next
Performance »
Docs
Community
More
Copyright © 2015–2021 Dan Abramov and the Redux documentation authors.
Last updated
