ソースを参照

refactor(router): 重命名登录配置参数并更新相关文档

将 `IS_USE_WX_LOGIN_IN_MP` 重命名为 `LOGIN_PAGE_ENABLE_IN_WP` 以更准确表达其用途
更新路由拦截逻辑和 README 文档以保持一致性
feige996 8 ヶ月 前
コミット
915184ce7e
4 ファイル変更28 行追加6 行削除
  1. 22 0
      src/pages/login/README.md
  2. 1 1
      src/router/README.md
  3. 3 3
      src/router/config.ts
  4. 2 2
      src/router/interceptor.ts

+ 22 - 0
src/pages/login/README.md

@@ -0,0 +1,22 @@
+# 登录页
+需要输入账号、密码/验证码的登录页。
+
+## 适用性
+
+本页面主要用于 `h5` 和 `APP`。
+
+小程序通常有平台的登录方式 `uni.login` 通常用不到登录页,所以不适用于 `小程序`。(即默认情况下,小程序环境是不会走登录拦截逻辑的。)
+
+但是如果您的小程序也需要现实的 `登录页` 那也是可以使用的。
+
+在 `src/router/config.ts` 中有一个变量 `LOGIN_PAGE_ENABLE_IN_WP` 来控制是否在小程序中使用 `H5的登录页`。
+
+更多信息请看 `src/router` 文件夹的内容。
+
+
+
+## 登录跳转
+
+目前登录的跳转逻辑主要在 `src/router/interceptor.ts` 和 `src/pages/login/login.vue` 里面,默认会在登录后自动重定向到来源/配置的页面。
+
+用户可以自行修改。

+ 1 - 1
src/router/README.md

@@ -52,4 +52,4 @@ definePage({
 
 特殊情况例外,如业务需要跨平台复用登录注册页时,也可以用在 `小程序` 上,所以主要还是看业务需求。
 
-通过一个参数 `IS_USE_WX_LOGIN_IN_MP` 来控制是否在 `小程序` 中使用 `小程序` 默认的登录逻辑。
+通过一个参数 `LOGIN_PAGE_ENABLE_IN_WP` 来控制是否在 `小程序` 中使用 `H5登录页` 的登录逻辑。

+ 3 - 3
src/router/config.ts

@@ -22,6 +22,6 @@ export const EXCLUDE_LOGIN_PATH_LIST = [
   ...excludeLoginPathList, // 都是以 / 开头的 path
 ]
 
-// 在微信小程序里面是否使用小程序默认的登录,默认为true
-// 如果为 false 则复用 h5 的登录逻辑
-export const IS_USE_WX_LOGIN_IN_MP = true
+// 在小程序里面是否使用H5的登录页,默认为 false
+// 如果为 true 则复用 h5 的登录逻辑
+export const LOGIN_PAGE_ENABLE_IN_WP = false

+ 2 - 2
src/router/interceptor.ts

@@ -7,7 +7,7 @@ import { isMp } from '@uni-helper/uni-env'
 import { useTokenStore } from '@/store/token'
 import { isPageTabbar, tabbarStore } from '@/tabbar/store'
 import { getAllPages, getLastPage, HOME_PAGE, parseUrlToObj } from '@/utils/index'
-import { EXCLUDE_LOGIN_PATH_LIST, IS_USE_WX_LOGIN_IN_MP, isNeedLoginMode, LOGIN_PAGE } from './config'
+import { EXCLUDE_LOGIN_PATH_LIST, isNeedLoginMode, LOGIN_PAGE, LOGIN_PAGE_ENABLE_IN_WP } from './config'
 
 export const FG_LOG_ENABLE = false
 export function judgeIsExcludePath(path: string) {
@@ -47,7 +47,7 @@ export const navigateToInterceptor = {
     tabbarStore.setAutoCurIdx(path)
 
     // 小程序里面使用平台自带的登录,则不走下面的逻辑
-    if (isMp && IS_USE_WX_LOGIN_IN_MP) {
+    if (isMp && LOGIN_PAGE_ENABLE_IN_WP) {
       return true // 明确表示允许路由继续执行
     }