# yzj-admin
**Repository Path**: yzjgroup/yzj-admin
## Basic Information
- **Project Name**: yzj-admin
- **Description**: YZJ 后台前端脚手架(含 Electron 配置)
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-02-10
- **Last Updated**: 2026-02-13
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
Yzj-SoybeanAdmin
## 简介
基于 [`SoybeanAdmin`](https://github.com/soybeanjs/soybean-admin) 进行二次开发,让其更简单更容易上手。主要讲解各项配置的修改(整体架构感觉还是挺复杂的)
## 配置文件
> 架构很多地方都是走配置的,所以这里先缕清一些常见的配置,知道它是干什么用的,这样方便我们后续自定义以及按照项目的整体设计进行后续的开发
### 环境配置
> 主要环境配置文件分为:.env 和 .env.prod 以及 .env.test;比较常用或者关键的信息,我这里会用红色粗体标注出来
- .env
- VITE_BASE_URL
- 项目基本地址
- VITE_APP_TITLE
- 项目标题
- VITE_APP_DESC
- 项目简介
- VITE_ICON_PREFIX
- 图标的前缀(渲染图标时可以用 icon_xxx_xxx)
- 可以参考 [`iconify`](https://iconify.design/) 的 css 名称
- VITE_ICON_LOCAL_PREFIX
- 本地图标前缀(同上,但是这里要单独维护到项目之中)
- VITE_AUTH_ROUTE_MODE
- 路由模式,指定 static 或 dynamic(这里是用于控制静态路由或者是动态获取路由)
- VITE_ROUTE_HOME
- 默认第一个静态路由,这里路由后面会讲到如何配置静态以及动态
- VITE_MENU_ICON
- 菜单的图标
- VITE_HTTP_PROXY
- 是否开启 HTTP 代理,在测试环境下处理跨域(dddd)
- VITE_ROUTER_HISTORY_MODE
- 路由的跳转模式 hash | history | memory(这里和 vue-router 一样的)
- VITE_SERVICE_SUCCESS_CODE
- 服务成功状态码,这里根据项目不同进行变更
- VITE_SERVICE_LOGOUT_CODES
- 服务器登出的状态码,当响应回来的状态码是这一类中,就会弹出回登录页面
- 这里常见给 Token、封禁等……一些操作可以使用
- VITE_SERVICE_EXPIRED_TOKEN_CODES
- Token 令牌过期状态码,当响应回来的状态码是这一类中,就会尝试去请求刷新 Token 的接口
- 这个不是每个服务的实现都是一样的,但是这里可以避免登出
- VITE_STATIC_SUPER_ROLE
- 当路由模式为静态时,定义的超级角色
- VITE_STORAGE_PREFIX
- 本地缓存前缀,方便用于定义不同的存储块
- VITE_AUTOMATICALLY_DETECT_UPDATE
- 用于控制程序是否自动检测更新
- .env.prod 和 .env.test
- VITE_SERVICE_BASE_URL
- 请求接口的基本地址
- VITE_OTHER_SERVICE_BASE_URL
- 其他请求接口基本地址
## 修改请求
> 请求是每个项目最基本的配置,所以优先解决这一个问题。这里先拿登录作为修改例子,并在此之前修改好 VITE_SERVICE_BASE_URL 为自己的程序接口地址
### login 流程的修改
> 这里将以修改 Login 请求为例子,大概梳理下它请求的整个规范
先在 /view/\_builtin/login 找到对应的页面在头部导入模块的那里定位 `import PwdLogin from './modules/pwd-login.vue';` 账号密码登录页面
而后可以看到它是通过 `store` 进行请求处理的,那么定位到 `import { useAuthStore } from '@/store/modules/auth';` 找到 `/store/modlues/auth/index.ts` 下的 `login` 方法
最终看到调用了 `const { data: loginToken, error } = await fetchLogin(userName, password);` 也就是 `import { fetchGetUserInfo, fetchLogin } from '@/service/api';` 点进去之后修改 `api`,如果发现请求成功,那说明更改这一步完成了,这时候如果请求成功,但是提示 ERROR 说明要修改对应的状态码(VITE_SERVICE_SUCCESS_CODE)
登录成功,之后会发现它还会报错(如果没定义 `/auth/getUserInfo` 我们这里就不需要定义了,修改为 `const pass = true`);
```ts
async function loginByToken(loginToken: Api.Auth.LoginToken) {
// 1. stored in the localStorage, the later requests need it in headers
localStg.set('token', loginToken.token);
localStg.set('refreshToken', loginToken.refreshToken);
// 2. get user info
// const pass = await getUserInfo();
const pass = true;
if (pass) {
token.value = loginToken.authorization;
return true;
}
return false;
}
```
继续往下走会看到 `loginByToken` 这里我们要修改为从请求头中获取
定位到 `/typings/api.d.ts` 找到 `Auth.LoginToken` 这里把它所有的引用改回其程序的对应信息,这里我改成:`authorization` 和 `refreshAuthorization(refresh-authorization)`;随即前往发送请求的地方 `/packages/axios/src/index.ts` 修改响应拦截操作
定位到 `instance.interceptors.response.use` 我们可以看到,他是通过 `opts.isBackendSuccess` 来自定义响应成功的处理行为。这时候我们回退到 `/service/request/index.ts` 找到 `request` 在 `isBackendSuccess` 调用 `store` 的 `loginByToken`
```ts
isBackendSuccess(response) {
const {authorization, 'refresh-authorization': refreshAuthorization} = response.headers;
if (authorization) {
localStg.set('token', authorization);
}
if (refreshAuthorization) {
localStg.set('refreshToken', refreshAuthorization);
}
// when the backend response code is "0000"(default), it means the request is success
// to change this logic by yourself, you can modify the `VITE_SERVICE_SUCCESS_CODE` in `.env` file
return String(response.data.code) === import.meta.env.VITE_SERVICE_SUCCESS_CODE;
}
```
修改完毕之后,如果接口正常返回,那么再登录就可以进入 Home 页面了
(PS:本地缓存的名称可改可不改,这里就先不改了,如果一定要改的话,就需要前往 `/typings/storage.d.ts` 全局修改 `StorageType.Local` 的引用)
```ts
async function login(userName: string, password: string, redirect = true) {
startLoading();
const { error } = await fetchLogin(userName, password);
if (!error) {
const pass = await loginByToken({
authorization: localStg.get('token') as string,
refreshAuthorization: localStg.get('refreshToken') as string
});
if (pass) {
await routeStore.initAuthRoute();
await redirectFromLogin(redirect);
if (routeStore.isInitAuthRoute) {
window.$notification?.success({
title: $t('page.login.common.loginSuccess'),
content: $t('page.login.common.welcomeBack', { userName: userInfo.userName }),
duration: 4500
});
}
}
} else {
resetStore();
}
endLoading();
}
```
## 追加路由
> 由于本项目是 clone 官方 template,所以没有 example,而它追加路由不像普通的项目那么简单。那么这里主要讲解下追加路由的几个步骤
路由分为静态路由和动态路由,静态路由是指由前端控制固定的路由菜单,动态路由则是通过接口 API 获取对应的路由菜单。
### 静态路由
> 静态路由顾名思义就是固定加载 `ts` 文件内的路由,这也是便捷开发最常用的,所以这里着重讲解静态路由的追加步骤
#### 命令创建
通过执行 `pnpm gen-route` 命令,可以快速创建路由文件(https://docs.soybeanjs.cn/zh/guide/router/create.html)
路由名称的命名规则
- 一级路由: demo, demo-page, route1
- 名称为小写加连字符-的形式
- 二级路由: demo2_child, demo2-page_child, route2_child
- 路由的层级用下划线\_分隔,两边仍然遵守一级路由的命名规则
- 三级及三级以上路由: demo3_child_child, demo3-page_child_child_child
其实就是假设定义了一级路由(job),那么它的二级路由(job-detail)就是(job_job-detail)下划线就是级别 `level`
#### 手动创建
其实可以先通过命令行创建,然后再去修改对应的配置文件,这样下来节省时间。那么这里就继续以已生成好的(job)路由为例子,定位到 `/router/elegant/routes.ts` 找到 `name: 'job'` 这里可以修改对应的配置,`params` 等……
路由名字在 `/locales/langs` 中找到 `route` 定义对应的信息