为所有 axios 请求附加授权 header
Attach Authorization header for all axios requests
我有一个 react/redux 应用程序,它从 api 服务器获取令牌。用户通过身份验证后,我想让所有 axios 请求都将该令牌作为授权 header,而不必手动将其附加到操作中的每个请求。我是 react/redux 的新手,不确定最佳方法,也没有在 google.
上找到任何质量匹配项这是我的 redux 设置:
// actions.js
import axios from 'axios';
export function loginUser(props) {
const url = `https://api.mydomain.com/login/`;
const { email, password } = props;
const request = axios.post(url, { email, password });
return {
type: LOGIN_USER,
payload: request
};
}
export function fetchPages() {
/* here is where I'd like the header to be attached automatically if the user
has logged in */
const request = axios.get(PAGES_URL);
return {
type: FETCH_PAGES,
payload: request
};
}
// reducers.js
const initialState = {
isAuthenticated: false,
token: null
};
export default (state = initialState, action) => {
switch(action.type) {
case LOGIN_USER:
// here is where I believe I should be attaching the header to all axios requests.
return {
token: action.payload.data.key,
isAuthenticated: true
};
case LOGOUT_USER:
// i would remove the header from all axios requests here.
return initialState;
default:
return state;
}
}
我的令牌存储在 state.session.token
下的 redux 存储中。
我对如何进行有点迷茫。我已经尝试在我的根目录中的文件中制作一个 axios instance 和 update/import 而不是来自 node_modules 但它不会在状态更改时附加 header 。任何 feedback/ideas 非常感谢,谢谢。
对我来说最好的解决方案是创建一个客户端服务,您将使用您的令牌实例化并使用它来包装 axios
。
import axios from 'axios';
const client = (token = null) => {
const defaultOptions = {
headers: {
Authorization: token ? `Token ${token}` : '',
},
};
return {
get: (url, options = {}) => axios.get(url, { ...defaultOptions, ...options }),
post: (url, data, options = {}) => axios.post(url, data, { ...defaultOptions, ...options }),
put: (url, data, options = {}) => axios.put(url, data, { ...defaultOptions, ...options }),
delete: (url, options = {}) => axios.delete(url, { ...defaultOptions, ...options }),
};
};
const request = client('MY SECRET TOKEN');
request.get(PAGES_URL);
在此客户端中,您还可以根据需要从 localStorage / cookie 中检索令牌。
有多种方法可以实现这一点。在这里,我解释了两种最常见的方法。
1。您可以使用 axios interceptors 拦截任何请求并添加授权 headers.
// Add a request interceptor
axios.interceptors.request.use(function (config) {
const token = store.getState().session.token;
config.headers.Authorization = token;
return config;
});
2。从 axios
的 documentation 中,您可以看到有一种机制可以让您设置默认值 header,它将随您发出的每个请求一起发送。
axios.defaults.headers.common['Authorization'] = AUTH_TOKEN;
所以在你的情况下:
axios.defaults.headers.common['Authorization'] = store.getState().session.token;
如果需要,您可以创建一个 self-executable 函数,当令牌出现在商店中时,它会自行设置授权 header。
(function() {
String token = store.getState().session.token;
if (token) {
axios.defaults.headers.common['Authorization'] = token;
} else {
axios.defaults.headers.common['Authorization'] = null;
/*if setting null does not remove `Authorization` header then try
delete axios.defaults.headers.common['Authorization'];
*/
}
})();
现在您不再需要为每个请求手动附加令牌。您可以将上述函数放在保证每次都执行的文件中(例如:包含路由的文件)。
希望对您有所帮助:)
如果您想在以后调用其他 api 路线并将您的令牌保存在商店中,请尝试 using redux middleware。
中间件可以侦听 api 操作并相应地通过 axios 发送 api 请求。
这是一个非常基本的例子:
actions/api.js
export const CALL_API = 'CALL_API';
function onSuccess(payload) {
return {
type: 'SUCCESS',
payload
};
}
function onError(payload) {
return {
type: 'ERROR',
payload,
error: true
};
}
export function apiLogin(credentials) {
return {
onSuccess,
onError,
type: CALL_API,
params: { ...credentials },
method: 'post',
url: 'login'
};
}
middleware/api.js
import axios from 'axios';
import { CALL_API } from '../actions/api';
export default ({ getState, dispatch }) => next => async action => {
// Ignore anything that's not calling the api
if (action.type !== CALL_API) {
return next(action);
}
// Grab the token from state
const { token } = getState().session;
// Format the request and attach the token.
const { method, onSuccess, onError, params, url } = action;
const defaultOptions = {
headers: {
Authorization: token ? `Token ${token}` : '',
}
};
const options = {
...defaultOptions,
...params
};
try {
const response = await axios[method](url, options);
dispatch(onSuccess(response.data));
} catch (error) {
dispatch(onError(error.data));
}
return next(action);
};
类似地,我们有一个函数可以从这样的调用中设置或删除令牌:
import axios from 'axios';
export default function setAuthToken(token) {
axios.defaults.headers.common['Authorization'] = '';
delete axios.defaults.headers.common['Authorization'];
if (token) {
axios.defaults.headers.common['Authorization'] = `${token}`;
}
}
我们总是在初始化时清理现有令牌,然后建立接收到的令牌。
创建 axios 实例:
// Default config options
const defaultOptions = {
baseURL: <CHANGE-TO-URL>,
headers: {
'Content-Type': 'application/json',
},
};
// Create instance
let instance = axios.create(defaultOptions);
// Set the AUTH token for any request
instance.interceptors.request.use(function (config) {
const token = localStorage.getItem('token');
config.headers.Authorization = token ? `Bearer ${token}` : '';
return config;
});
然后对于任何请求,令牌将从 localStorage select 中添加到请求 headers。
我使用以下代码在整个应用程序中使用相同的实例:
import axios from 'axios';
const fetchClient = () => {
const defaultOptions = {
baseURL: process.env.REACT_APP_API_PATH,
method: 'get',
headers: {
'Content-Type': 'application/json',
},
};
// Create instance
let instance = axios.create(defaultOptions);
// Set the AUTH token for any request
instance.interceptors.request.use(function (config) {
const token = localStorage.getItem('token');
config.headers.Authorization = token ? `Bearer ${token}` : '';
return config;
});
return instance;
};
export default fetchClient();
祝你好运。
有时您会遇到这样一种情况,即某些使用 axios 发出的请求指向不接受授权 header 的端点。因此,仅在允许的域上设置授权 header 的替代方法如下例所示。将以下函数放在每次 React 应用程序运行时执行的任何文件中,例如在路由文件中。
export default () => {
axios.interceptors.request.use(function (requestConfig) {
if (requestConfig.url.indexOf(<ALLOWED_DOMAIN>) > -1) {
const token = localStorage.token;
requestConfig.headers['Authorization'] = `Bearer ${token}`;
}
return requestConfig;
}, function (error) {
return Promise.reject(error);
});
}
尝试像我下面那样创建新实例
var common_axios = axios.create({
baseURL: 'https://sample.com'
});
// Set default headers to common_axios ( as Instance )
common_axios.defaults.headers.common['Authorization'] = AUTH_TOKEN;
// Check your Header
console.log(common_axios.defaults.headers);
如何使用它
common_axios.get(url).......
common_axios.post(url).......
export const authHandler = (config) => {
const authRegex = /^\/apiregex/;
if (!authRegex.test(config.url)) {
return store.fetchToken().then((token) => {
Object.assign(config.headers.common, { Authorization: `Bearer ${token}` });
return Promise.resolve(config);
});
}
return Promise.resolve(config);
};
axios.interceptors.request.use(authHandler);
运行 在尝试实现类似的东西时陷入了一些陷阱,基于这些答案,这就是我想出的。我遇到的问题是:
- 如果使用 axios 请求在您的商店中获取令牌,您需要在添加 header 之前检测路径。如果您不这样做,它也会尝试将 header 添加到该调用并陷入循环路径问题。添加正则表达式以检测其他调用的逆过程也可以工作
- 如果商店 return 承诺,您需要 return 调用商店以解决 authHandler 函数中的承诺。 Async/Await 功能将使这个 easier/more 显而易见
- 如果对 auth 令牌的调用失败或者是获取令牌的调用,您仍然希望通过配置解决承诺
重点是为每个请求在拦截器上设置令牌
import axios from "axios";
const httpClient = axios.create({
baseURL: "http://youradress",
// baseURL: process.env.APP_API_BASE_URL,
});
httpClient.interceptors.request.use(function (config) {
const token = localStorage.getItem('token');
config.headers.Authorization = token ? `Bearer ${token}` : '';
return config;
});