From b5ab025fc2bf1f0b7ee9b9ba37074ea38bf37ed6 Mon Sep 17 00:00:00 2001
From: YunaiV <zhijiantianya@gmail.com>
Date: Mon, 14 Oct 2024 20:16:48 +0800
Subject: [PATCH] =?UTF-8?q?code=20review=EF=BC=9A=E5=8F=8C=20token=20?=
 =?UTF-8?q?=E5=AE=9E=E7=8E=B0=E3=80=82?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 env/.env                                       |  2 +-
 src/interceptors/route.ts                      | 12 ++++++------
 src/manifest.json                              |  2 +-
 src/pages/colab/index.vue                      |  1 +
 src/pages/contacts/components/ContactsItem.vue |  4 ++--
 src/pages/contacts/index.vue                   |  1 +
 src/pages/login/components/LoginForm.vue       |  4 ++--
 src/pages/login/index.vue                      |  1 +
 src/pages/message/components/MessageItem.vue   |  1 -
 src/pages/message/index.vue                    |  1 +
 src/pages/work/components/AppItems.vue         |  1 -
 src/pages/work/index.vue                       |  1 +
 src/types/system.d.ts                          |  2 +-
 src/utils/common.ts                            |  2 ++
 src/utils/http.ts                              | 11 +++++------
 src/utils/index.ts                             |  2 +-
 16 files changed, 26 insertions(+), 22 deletions(-)

diff --git a/env/.env b/env/.env
index eb594ff..1cfc505 100644
--- a/env/.env
+++ b/env/.env
@@ -1,4 +1,4 @@
-VITE_APP_TITLE = 'ruoyi-vue-pro'
+VITE_APP_TITLE = '芋道管理系统'
 VITE_APP_PORT = 9000
 
 VITE_UNI_APPID = 'H57F2ACE4'
diff --git a/src/interceptors/route.ts b/src/interceptors/route.ts
index 016d9fc..252855b 100644
--- a/src/interceptors/route.ts
+++ b/src/interceptors/route.ts
@@ -6,11 +6,11 @@
  *
  * update 2024-10-09
  * 登录之后，会进行页面跳转。在完成页面跳转之前，就需要获取到用户信息
- * 并设置到userStore中。
- * 
+ * 并设置到 userStore 中。
+ *
  * 如何设置当前页面需要校验登录状态？
- * 在router块中设置
- * 
+ * 在 router 块中设置
+ *
  * <route lang="json5">
     {
       layout: 'tabbar',
@@ -60,10 +60,10 @@ const navigateToInterceptor = {
       return option
     }
 
-    // 下面的逻辑跟PC端差不多
+    // 下面的逻辑跟 PC 端差不多
     if (getAccessToken()) {
       if (path === '/pages/login/index') {
-        // 这里写死，避免在login页面中设置了needLogin，导致死循环
+        // 这里写死，避免在 login 页面中设置了 needLogin，导致死循环
         return option
       } else {
         // todo  获取字典数据并保存到本地
diff --git a/src/manifest.json b/src/manifest.json
index 3a9762f..f7fbc9e 100644
--- a/src/manifest.json
+++ b/src/manifest.json
@@ -1,5 +1,5 @@
 {
-  "name": "ruoyi-vue-pro",
+  "name": "芋道管理系统",
   "appid": "H57F2ACE4",
   "description": "",
   "versionName": "1.0.0",
diff --git a/src/pages/colab/index.vue b/src/pages/colab/index.vue
index 9437be7..5645a48 100644
--- a/src/pages/colab/index.vue
+++ b/src/pages/colab/index.vue
@@ -1,3 +1,4 @@
+<!-- 协作界面：用于 bpm 工作流 -->
 <route lang="json5" type="page">
 {
   layout: 'tabbar',
diff --git a/src/pages/contacts/components/ContactsItem.vue b/src/pages/contacts/components/ContactsItem.vue
index a4246a9..d5d539a 100644
--- a/src/pages/contacts/components/ContactsItem.vue
+++ b/src/pages/contacts/components/ContactsItem.vue
@@ -1,4 +1,4 @@
-<!-- 通讯录item -->
+<!-- 通讯录 item -->
 <template>
   <view class="flex justify-between w-full">
     <!-- 头像 -->
@@ -13,7 +13,7 @@
     <view
       class="h-100rpx grow-1 flex flex-col justify-center border-solid border-b-[0.5px] border-x-0 border-t-0 border-[#E3E2E2]"
     >
-      <!-- 如果是个人 s -->
+      <!-- 如果是个人 -->
       <view v-if="props.item.isLeaf">
         <view class="text-24rpx">{{ props.item.name }}</view>
         <view class="text-22rpx">
diff --git a/src/pages/contacts/index.vue b/src/pages/contacts/index.vue
index 7e5fe60..1cc263c 100644
--- a/src/pages/contacts/index.vue
+++ b/src/pages/contacts/index.vue
@@ -1,3 +1,4 @@
+<!-- 通讯录界面：用于 im 聊天 -->
 <route lang="json5" type="page">
 {
   layout: 'tabbar',
diff --git a/src/pages/login/components/LoginForm.vue b/src/pages/login/components/LoginForm.vue
index 50b115c..b449cbb 100644
--- a/src/pages/login/components/LoginForm.vue
+++ b/src/pages/login/components/LoginForm.vue
@@ -73,7 +73,7 @@ import { login, getTenantIdByName } from '@/service/login/LoginAPI'
 import { useUserStore } from '@/store'
 import * as authUtil from '@/utils/auth'
 
-// 提示组件
+// 提示组件 TODO @ Qiksy 讨论：// 提示组件 这种，我们要不放在 useToast()，作为尾注释，简洁一点。
 const toast = useToast()
 
 const focusInput = ref('')
@@ -102,7 +102,7 @@ const loginData = reactive({
   },
 })
 
-// 获取租户 ID
+// 获取租户 ID // TODO @ Qiksy 讨论：这个方法注释，要不用 /** 获取租户 ID */ 高亮的更明显哈。
 const getTenantId = async () => {
   if (loginData.tenantEnable === 'true') {
     const res = (await getTenantIdByName(loginData.loginForm.tenantName)) as string
diff --git a/src/pages/login/index.vue b/src/pages/login/index.vue
index fd4deba..9479b3b 100644
--- a/src/pages/login/index.vue
+++ b/src/pages/login/index.vue
@@ -14,6 +14,7 @@
         <view><text class="text-[64rpx] font-700">你好</text></view>
         <view class="mt-[36rpx]"><text class="text-[36rpx]">欢迎登录芋道快速开发平台</text></view>
       </view>
+      <!-- TODO @芋艿：后续把静态资源，放到 CDN -->
       <image
         class="absolute w-full top-0 -z-1"
         src="/static/images/login-bg.png"
diff --git a/src/pages/message/components/MessageItem.vue b/src/pages/message/components/MessageItem.vue
index a1ad1fe..d3222f7 100644
--- a/src/pages/message/components/MessageItem.vue
+++ b/src/pages/message/components/MessageItem.vue
@@ -1,5 +1,4 @@
 <!-- 消息列表组件 -->
-
 <template>
   <view class="w-full flex justify-between">
     <view class="w-100rpx h-100rpx flex items-center justify-center">
diff --git a/src/pages/message/index.vue b/src/pages/message/index.vue
index edc77e5..c784323 100644
--- a/src/pages/message/index.vue
+++ b/src/pages/message/index.vue
@@ -1,3 +1,4 @@
+<!-- 消息界面：用于 im 聊天 -->
 <route lang="json5" type="page">
 {
   layout: 'tabbar',
diff --git a/src/pages/work/components/AppItems.vue b/src/pages/work/components/AppItems.vue
index a9ff9a2..bd104d8 100644
--- a/src/pages/work/components/AppItems.vue
+++ b/src/pages/work/components/AppItems.vue
@@ -1,5 +1,4 @@
 <!-- 工作台图标 -->
-
 <template>
   <view class="flex flex-col items-center gap-1" @click="handleClick">
     <view class="bg-blue-500 rounded-5px w-80rpx h-80rpx flex flex-col items-center justify-center">
diff --git a/src/pages/work/index.vue b/src/pages/work/index.vue
index 47e7ae9..9ec4f98 100644
--- a/src/pages/work/index.vue
+++ b/src/pages/work/index.vue
@@ -1,3 +1,4 @@
+<!-- 工作台界面：用于各种 crud 管理操作 -->
 <route lang="json5" type="home">
 {
   layout: 'tabbar',
diff --git a/src/types/system.d.ts b/src/types/system.d.ts
index 403f1f6..5a18f0f 100644
--- a/src/types/system.d.ts
+++ b/src/types/system.d.ts
@@ -5,8 +5,8 @@ type UserVO = {
   deptId: number
 }
 
+// USER 缓存
 type UserInfoVO = {
-  // USER 缓存
   permissions: string[]
   roles: string[]
   isSetUser: boolean
diff --git a/src/utils/common.ts b/src/utils/common.ts
index 998061e..a122276 100644
--- a/src/utils/common.ts
+++ b/src/utils/common.ts
@@ -1,5 +1,6 @@
 /**
  * 显示模态弹窗
+ *
  * @param content 提示的标题
  */
 export function showConfirm(content: string) {
@@ -18,6 +19,7 @@ export function showConfirm(content: string) {
 
 /**
  * 显示消息提示框
+ *
  * @param content 提示的标题
  */
 export function toast(content: string) {
diff --git a/src/utils/http.ts b/src/utils/http.ts
index edc41c4..e2e6fe3 100644
--- a/src/utils/http.ts
+++ b/src/utils/http.ts
@@ -6,11 +6,10 @@ import { getEvnBaseUrl } from '@/utils'
 import errorCode from './errorCode'
 
 /*
-  双token刷新说明
-  1. token和tenantId都是在拦截器中赋值
-  2. 后端并不直接更改http statusCode，而是返回一个重新包装后的对象，
-  所以不能使用失败回调函数就行判断token是否过期需要重新获取
-  3. 应该在success中，解析res，如果code是401，则说明token过期，需要重新获取
+  双 token 刷新说明：
+  1. token 和 tenantId 都是在拦截器中赋值
+  2. 后端并不直接更改 http statusCode，而是返回一个重新包装后的对象，所以不能使用失败回调函数就行判断token是否过期需要重新获取
+  3. 应该在 success 中，解析 res，如果 code 是 401，则说明 access token 过期，需要重新获取
 */
 
 // 是否正在刷新中
@@ -115,7 +114,7 @@ export const http = <T>(options: CustomRequestOptions) => {
           reject(errorCode['500'])
         } else if (code !== 0) {
           // 其他的错误
-          // ps：ruoyi-vue-pro 的success 的code，默认是0而不是200
+          // ps：yudao 的 success 的 code，默认是 0 而不是 200
           toast(msg)
           reject(code)
         }
diff --git a/src/utils/index.ts b/src/utils/index.ts
index 853a739..8283d7d 100644
--- a/src/utils/index.ts
+++ b/src/utils/index.ts
@@ -131,7 +131,7 @@ export const getEvnBaseUrl = () => {
     const {
       miniProgram: { envVersion },
     } = uni.getAccountInfoSync()
-    // 开发、体验、正式版 三种不同的小程序都可以配置不同的后端url
+    // 开发、体验、正式版 三种不同的小程序都可以配置不同的后端 url
     switch (envVersion) {
       case 'develop':
         baseUrl = 'http://localhost:48080/admin-api'