【实战】 JWT、用户认证与异步请求(1) —— React17+React Hook+TS4 最佳实践,仿 Jira 企业级项目(四)

news/2024/11/29 13:35:27/

文章目录

    • 一、项目起航:项目初始化与配置
    • 二、React 与 Hook 应用:实现项目列表
    • 三、TS 应用:JS神助攻 - 强类型
    • 四、JWT、用户认证与异步请求
      • 1.login
      • 2.middleware of json-server
      • 3.jira-dev-tool(imooc-jira-tool)
        • 安装
        • 问题
          • 问题一
          • 问题二
        • 使用
      • 4.JWT原理与auth-provider实现
        • 注册一个新用户
        • auth-provider
      • 5.useContext(user,login,register,logout)


学习内容来源:React + React Hook + TS 最佳实践-慕课网


相对原教程,我在学习开始时(2023.03)采用的是当前最新版本:

版本
react & react-dom^18.2.0
react-router & react-router-dom^6.11.2
antd^4.24.8
@commitlint/cli & @commitlint/config-conventional^17.4.4
eslint-config-prettier^8.6.0
husky^8.0.3
lint-staged^13.1.2
prettier2.8.4
json-server0.17.2
craco-less^2.0.0
@craco/craco^7.1.0
qs^6.11.0
dayjs^1.11.7
react-helmet^6.1.0
@types/react-helmet^6.1.6
react-query^6.1.0
@welldone-software/why-did-you-render^7.0.1
@emotion/react & @emotion/styled^11.10.6

具体配置、操作和内容会有差异,“坑”也会有所不同。。。


一、项目起航:项目初始化与配置

  • 【实战】 项目起航:项目初始化与配置 —— React17+React Hook+TS4 最佳实践,仿 Jira 企业级项目(一)

二、React 与 Hook 应用:实现项目列表

  • 【实战】 React 与 Hook 应用:实现项目列表 —— React17+React Hook+TS4 最佳实践,仿 Jira 企业级项目(二)

三、TS 应用:JS神助攻 - 强类型

  • 【实战】 TS 应用:JS神助攻 - 强类型 —— React17+React Hook+TS4 最佳实践,仿 Jira 企业级项目(三)

四、JWT、用户认证与异步请求

1.login

  • 新建文件:src\screens\login\index.tsx
import { FormEvent } from "react";const apiUrl = process.env.REACT_APP_API_URL;export const Login = () => {const login = (param: { username: string; password: string }) => {fetch(`${apiUrl}/login`, {method: "POST",headers: {"Content-Type": "application/json",},body: JSON.stringify(param),}).then(async (res) => {if (res.ok) {}});};// HTMLFormElement extends Element (子类型继承性兼容所有父类型)(鸭子类型:duck typing: 面向接口编程 而非 面向对象编程)const handleSubmit = (event: FormEvent<HTMLFormElement>) => {event.preventDefault();const username = (event.currentTarget.elements[0] as HTMLFormElement).value;const password = (event.currentTarget.elements[1] as HTMLFormElement).value;login({ username, password });};return (<form onSubmit={handleSubmit}><div><label htmlFor="username">用户名</label><input type="text" id="username" /></div><div><label htmlFor="password">密码</label><input type="password" id="password" /></div><button type="submit">登录</button></form>);
};
  • src\App.tsx 中引入:
import "./App.css";
import { Login } from "screens/login";function App() {return (<div className="App"><Login /></div>);
}export default App;

目前页面点击登录 404,下一步配置 json-server 中间件,使其可以模拟 非 restful 接口

2.middleware of json-server

  • 新建文件:__json_server_mock__\middleware.js
module.exports = (req, res, next) => {if (req.method === "POST" && req.path === "/login") {if (req.body.username === "user" && req.body.password === "123") {return res.status(200).json({user: {token: "token123",},});} else {return res.status(400).json({ message: "用户名或者密码错误" });}}next();
};
  • 配置 package.jsonjson-serverscript
"json-server": "json-server __json_server_mock__/db.json -w -p 3001 --middlewares ./__json_server_mock__/middleware.js"
  • 配置完后重新启动 json-server ,输入中间件预置用户名和密码即可正常访问(200),否则(400:bad request)

3.jira-dev-tool(imooc-jira-tool)

jira-dev-tool - npm

安装

  • 首先确认 git 工作区 clean,安装 jira-dev-tool(imooc-jira-tool)
npx imooc-jira-tool
  • 引入到 src\index.tsx
import { loadDevTools } from "jira-dev-tool";loadDevTools(() => {ReactDOM.render(<React.StrictMode><AppProviders><App /></AppProviders></React.StrictMode>,document.getElementById("root"));
});

这一步后页面会多出一个“齿轮”,点击即可使用 jira-dev-tool

问题

安装 jira-dev-tool(imooc-jira-tool)后启动项目联调可能会出现的问题

问题一
  • 报错:
request (TypeError: Failed to fetch). This is probably not a problem with Mock Service Worker. There is likely an additional logging output above.
  • 解决:
npx msw init ./public/ --save
问题二

由于 jira-dev-tool 已经两年没有更新了,且依赖 react@“^16.0.0”, 若要继续使用,在 npm i 时会有如下报错:

npm ERR! code ERESOLVE
npm ERR! ERESOLVE unable to resolve dependency tree
npm ERR! 
npm ERR! While resolving: jira@0.1.0
npm ERR! Found: react@18.2.0
npm ERR! node_modules/react
npm ERR!   react@"^18.2.0" from the root project
npm ERR!
npm ERR! Could not resolve dependency:
npm ERR! peer react@"^16.0.0" from jira-dev-tool@1.7.61       
npm ERR! node_modules/jira-dev-tool
npm ERR!   jira-dev-tool@"^1.7.61" from the root project      
npm ERR!
npm ERR! Fix the upstream dependency conflict, or retry       
npm ERR! this command with --force or --legacy-peer-deps      
npm ERR! to accept an incorrect (and potentially broken) dependency resolution.
npm ERR!
npm ERR!
npm ERR! For a full report see:
npm ERR! C:\...\npm-cache\_logs\2023-03-08T09_11_24_998Z-eresolve-report.txtnpm ERR! A complete log of this run can be found in:
npm ERR! C:\...\npm-cache\_logs\2023-03-08T09_11_24_998Z-debug-0.log

解决方案一:

  • 删掉文件 yarn.lock,以及package.json 中的 "jira-dev-tool": "^1.7.61", 部分,jira-dev-tool 手动安装

解决方案二(推荐)

  • 使用 yarn 代替 npm i

使用

  • 开发者工具用 MSW 以 Service Worker 为原理实现了"分布式后端"
  • 后端逻辑处理后,以localStorage为数据库进行增删改查操作
  • 浏览器上安装了一个独立的后端服务和数据库,再也不受任何中心化服务的影响 点击’清空数据库’便可以重置后端服务
  • 可以精准地控制 HTTP请求的时间、失败概率、失败规则
  • Service Worker + localStorage虽然本质上与传统后端服务并不同,但丝毫不会影响前端开发

其他具体操作可见文档以及接下来的操作:jira-dev-tool - npm

  • Service Worker API - Web API 接口参考 | MDN

安装好后进入/login,请求login接口,可以看到状态码后带有(from service worker)字样即成功连接:

在这里插入图片描述

开发工具控制台第一个tab页设置请求最短时间、请求失败比例:

在这里插入图片描述

开发工具控制台将/login添加到异步请求失败设置中,状态码 400 变为 500,提示:“请求失败,请检查 jira-dev-tool 的设置”:
在这里插入图片描述

4.JWT原理与auth-provider实现

注册一个新用户

  • 修改:src\screens\login\index.tsx
    • 调用接口 login 改为 register
    • 按钮 登录 改为 注册

注册一个新用户 jira(密码:jira),接口返回:

{"user": {"id": 2087569429,"name": "jira","token": "MjA4NzU2OTQyOQ=="}
}

token 即是 JWT(JSON Web Tokens) 的产物

  • JSON Web Tokens - jwt.io

auth-provider

修改 src\screens\ProjectList\components\SearchPanel.tsx,为 User 新增 token:

export interface User {id: string;name: string;email: string;title: string;organization: string;token: string;
}
...

新建 src\auth-provider.ts

模拟第三方服务

// 在真实环境中,如果使用了 firebase 这种第三方 auth 服务的话,本文件不需要开发者开发import { User } from "screens/ProjectList/components/SearchPanel"const localStorageKey = '__auth_provider_token__'
const apiUrl = process.env.REACT_APP_API_URL;export const getToken = () => window.localStorage.getItem(localStorageKey)export const handleUserResponse = ({user} : { user: User }) => {window.localStorage.setItem(localStorageKey, user.token || '')return user
}export const login = (data: { username: string, password: string }) => {return fetch(`${apiUrl}/login`, {method: "POST",headers: {"Content-Type": "application/json",},body: JSON.stringify(data),}).then(async (res) => {if (res.ok) {return handleUserResponse(await res.json())} else {return Promise.reject(data)}});
}export const register = (data: { username: string, password: string }) => {return fetch(`${apiUrl}/register`, {method: "POST",headers: {"Content-Type": "application/json",},body: JSON.stringify(data),}).then(async (res) => {if (res.ok) {return handleUserResponse(await res.json())} else {return Promise.reject(data)}});
}export const logout = async () => window.localStorage.removeItem(localStorageKey)

细节点:

  • 函数定义时,值前添加 async 使其返回一个 Promise 对象
  • 回调函数入参和回调函数内有且只有一个函数调用且它的入参与回调函数入参一致,该回调函数可直接简写为其内部的函数调用且不带参(这是函数式编程-PointFree的一种应用):
    • const login = (form: AuthForm) => auth.login(form).then(user => setUser(user))
    • const login = (form: AuthForm) => auth.login(form).then(setUser)

【笔记】函数式编程——PointFree

5.useContext(user,login,register,logout)

新建 src\context\auth-context.tsx

import React, { ReactNode, useState } from "react"
import * as auth from 'auth-provider'
import { User } from "screens/ProjectList/components/SearchPanel"interface AuthForm {username: string,password: string
}const AuthContext = React.createContext<{user: User | null,login: (form : AuthForm) => Promise<void>,register: (form : AuthForm) => Promise<void>,logout: () => Promise<void>,
} | undefined>(undefined)AuthContext.displayName = 'AuthContext'export const AuthProvider = ({children}:{children: ReactNode}) => {// 这里要考虑到初始值的类型与后续值类型,取并组成一个泛型const [user, setUser] = useState<User | null>(null)const login = (form: AuthForm) => auth.login(form).then(user => setUser(user))const register = (form: AuthForm) => auth.register(form).then(user => setUser(user))const logout = () => auth.logout().then(() => setUser(null))return <AuthContext.Provider children={children} value={{ user, login, register, logout }}/>
}export const useAuth = () => {const context = React.useContext(AuthContext)if (!context) {throw new Error('useAuth 必须在 AuthProvider 中使用')}return context
}

新建 src\context\index.tsx

import { ReactNode } from "react";
import { AuthProvider } from "./auth-context";export const AppProvider = ({children}:{children: ReactNode}) => {return <AuthProvider>{children}</AuthProvider>
}

在项目中使用 AppProvider,修改 src\index.tsx

import { AppProvider } from "context";
...
loadDevTools(() => {root.render(// <React.StrictMode><AppProvider><App /></AppProvider>// </React.StrictMode>);
});
...

修改 src\screens\login\index.tsx,调用 useAuth 中的 login,并使用之前注册的账号 jira(jira) 验证:

import { useAuth } from "context/auth-context";
import { FormEvent } from "react";export const Login = () => {const {login, user} = useAuth()// HTMLFormElement extends Element (子类型继承性兼容所有父类型)(鸭子类型:duck typing: 面向接口编程 而非 面向对象编程)const handleSubmit = (event: FormEvent<HTMLFormElement>) => {...};return (<form onSubmit={handleSubmit}><div>{user ? <div>登录成功,用户名{user?.name}</div> : null}</div><div><label htmlFor="username">用户名</label><input type="text" id="username" /></div><div><label htmlFor="password">密码</label><input type="password" id="password" /></div><button type="submit">登录</button></form>);
};

部分引用笔记还在草稿阶段,敬请期待。。。


http://www.ppmy.cn/news/551044.html

相关文章

MySQL生产环境高可用架构详解

一、MySQL高可用集群介绍 1、数据库主从架构与分库分表 随着现在互联网的应用越来越大&#xff0c;数据库会频繁的成为整个应用的性能瓶颈。而 我们经常使用的MySQL数据库&#xff0c;也会不断面临数据量太大、数据访问太频繁、数据 读写速度太快等一系列的问题。所以&#xf…

GO学习之入门语法

GO系列 1、GO学习之Hello World 2、GO学习之入门语法 文章目录 GO系列前言一&#xff1a;基础数据类型1.1 基本类型1.2 引用类型 二&#xff1a;基本操作2.1 if else2.2 for / range2.3 switch2.4 goto2.5 break / continue 三&#xff1a;总结 前言 最近新老大找我聊天&…

第三方库介绍——mosquitto

文章目录 概述程序&#xff08;指令&#xff09;说明安装服务端与客户端服务端指令配置配置文件&#xff1a;mosquitto.conf认证配置&#xff1a;pwfile权限配置&#xff1a;aclfile启动服务器&#xff0c;选择配置文件&#xff1a;mosquitto.conf 测试发布指令&#xff1a;订阅…

基于树莓派4B的OpenCV安装与简单应用(真速通版)

前言&#xff1a;本文为手把手教学树莓派4B的OpenCV安装与简单应用&#xff08;真速通版本&#xff09;&#xff0c;树莓派4B最为目前最新款的树莓派家族一员深受创客和开发者喜爱。树莓派4B作为一款搭载 Cortex-A72 系列芯片的板载电脑&#xff0c;其不仅可以作为简单的 MCU 进…

基于屏幕像素抖动的PCF

PCF无非就是把周围的像素加吧加吧, 然后取个平均值. 结果的平滑程度, 跟Kernel的大小有直接关系. 下面来对这个描过边的锯齿茶壶PCF一把: 2x2: 3x3: 4x4: 当然, Kernel越大, 效果越好. 但大到一定程度效果就不明显了, 而且还要考虑性能问题, 毕竟多次的纹理采样很慢. 其实呢, …

Godot屏幕抖动效果原理与实现

要用Godot实现屏幕/相机抖动效果&#xff0c;调查了网上的一些实现方案&#xff0c;效果都很不满意&#xff0c;于是自己实现了一个。 原理 从渲染过程看&#xff0c;实际发生抖动的是场景相机。 抖动过程对应物理学上的振动&#xff08;物理量在某个定值附近反复变化&#x…

游戏界面缩放后屏幕抖动的问题

最近解决了一个游戏界面缩放后屏幕抖动的问题&#xff0c;拿来与大家分享一下。 我们公司的游戏在界面缩放到75%、50%、40%、25%后会出现明显的画面抖动&#xff0c;最后近过同事们的协助和努力之后&#xff0c;明白了DDraw缩放的规律&#xff0c;大致上的过程应该是&#xff…

计算机术语 抖动,如果计算机屏幕闪烁和抖动,该怎么办

如果计算机屏幕闪烁和抖动&#xff0c;该怎么办 对于经常使用计算机的朋友来说&#xff0c;监视器屏幕是每个人一直都必须面对的东西。电脑屏幕的闪烁或晃动会使您很快感到疲劳&#xff0c;并严重影响视力&#xff0c;因此建议您遇到电脑屏幕闪烁的情况&#xff0c;否则电脑屏幕…