p-share-utils-test
v2.17.1
Published
### 技术栈 框架体系： `react - v1.18.12 / redux / typescript - v4.0`
Downloads
21
Readme
KMG FONT-END 2C 项目开发指南
技术栈
框架体系：
react - v1.18.12 / redux / typescript - v4.0
其他：
webpack / scss / lodash / axios
安装工程
npm start
启动工程
npm run build -> 编译/打包/开发模式 -> 开发模式 -> 对应项目-对应客户端
开发/打包配置
参见 /deployment/projects.config.js
插件
请在VS CODE中安装以下插件，来激活团队IDE配置与格式化配置Prettier, EditorConfig
跨域
默认开发时的API接口为：webpack - proxy
基本目录结构
配置管理
为了最大程度复用和分离平台与端的耦合，配置采用三层配置并使用继承与复写来
- 公共配置：
core/constants/configs- 该配置影响全平台 - 项目配置：
views/{platform}/public/configs.ts- 影响某平台（不分端），在此配置中引用公共配置，并向下导出 - 客户端配置：
views/{platform}/{client}/configs.ts- 影响单平台单端，在此配置中引用项目配置
例：全平台公共配置 DEFAULT_AGENT_CODE，但其中A平台有URL差异，则在【项目配置】中进行变量复写
import CONFIG from '@constants/configs';
export const DEFAULT_AGENT_CODE = '000222'
export default {
...CONFIG,
DEFAULT_AGENT_CODE
}相同，如果只是客户端级别差异，则在【客户端配置】中进行复写
别名
对于不同工程的私有路径，如何在公共组件中进行区分，例如：
KMG前台平台配置文件路径：src/views/kmg/desktop/config.ts
KMG后台配置文件路径：src/views/kmg-backend/desktop/config.ts
在公共组件中要使用对应的配置文件就需要用到别名进行处理
// projects.config.js
const kmg = {
client: client === 'pc' ? 'desktop' : 'mobile',
base: 'mc',
}
// webpack
const alias = {
'@this': path.join(__dirname, `../src/views/${CONFIG.base}/${CONFIG.client}`)
}
// component
import CONFIGS from '@this/config'接口缓存
对于接口数据缓存，添加了以下参数进行拓展：
/**
* 请求缓存相关
* @param expires 缓存时间 单位 分钟
* @param forward 当有缓存数据时，是否仍然请求去更新当前缓存
* @param isUserBind 该缓存是否绑定当前用户
* @param cacheClear 是否弃用当前缓存数据，重新缓存
*/接口超时处理
接口超时处理如下图所示：
/**
* 请求超时相关
* @param timeout 自定义超时时间 单位 s
* @param timeoutCallback 自定义超时回调函数
* @param maxRetry 最大重试次数
*/
页面白屏异常处理
对于页面/子组件在render过程中发成报错造成的白屏，针对多个项目在 /views/$client/components/PageHOC 中使用 class component 中 componentDidCatch 生命周期将其捕获，后经
/views/$client/pages/Error 将其错误信息进行友好抛出，核心代码如下：
class ErrorHandler extends React.Component {
constructor(props: any) {
super(props);
this.state = { hasError: false };
}
componentDidCatch(error: any) {
this.setState({ hasError: error })
}
render() {
if ((this.state as any).hasError) {
return <ErrorScreen log={(this.state as any).hasError} />
}
return (this.props as any).children
}
}React HOOK
React hook作为本次重构的核心，在解耦合中起了重要的作用，已将在class component中以下部分移植到HOOK中
- 所有HOC相关的操作
- 所有services的操作
- 不区分客户端的组件生命周期管理
- redux相关操作
aHook库作为常用的 hook 被添加使用 官方文档
样式管理
目录
对于大多数【页面】/【组件】，在同一目录下都一一对应一个style scss文件相依赖，例如：
- 首页
home/index.tsx在其同一目录中home/style.scss与之对应 - banner
template/desktop/components/banner/index.tsx在其同一目录中/style.scss与之对应
主要的依赖结构
模块化
为了避免相同className导致不同组件间样式冲突，每个组件或者页面都使用css模块化进行root节点类命名
:local(.wrapper){
}import css from './style.scss';
return (
<div className={css.wrapper}>
</div>
)头部引用规范
对于依赖引用，应按照如下顺序从上之下进行引用
- ts定义文件
import { TAction } from './_actionTypes.d.ts' - 第三方库
import dayJs from 'dayjs'/import QR from 'qrcode.react'etc.. - 逻辑层HOOK
import useLogin from '@hooks/useLogin' - 组件
import Popup from '@this/shadow/Popup'/import Child from '../Child'etc... - 帮助/全局类
import G from '@constants/global'/import { formatDate } from '@helpers/unit'etc... - 样式
import css from './style.scss'一个相对完整的示例如下：
import { TAction } from './_actionTypes.d.ts'
import { useParams } from 'react-router';
import usePromotion from "@core/hooks/usePromotion";
import usePublicState from "@core/hooks/usePublicState";
import PageHOC from "@this/components/PageHOC";
import { SkeletonLoader, NoData } from '@this/shadow/Loading';
import Banner from '@this/shadow/Banner';
import Select from '@this/shadow/Select';
import G from '@constans/global'
import css from './style.scss';文件注释规范
推荐使用VS Code头部注释插件：【koroFileHeader】并添加以下配置到 IDE SETTINGS 中
// 头部注释
"fileheader.customMade": {
"Author": "${your name}.GE",
"Date": "Do not edit",
"LastEditors": "${your name}.GE",
"FilePath": "Do not edit",
"Description": "",
},
// 函数注释
"fileheader.cursorMode": {
"Author": "${your name}.GE",
"Date": "Do not edit",
"description": "",
"param": "",
"return": "",
},