create-young-proj 1.2.0 → 1.2.1

package/CHANGELOG.md

@@ -1,6 +1,24 @@
 # Changelog
 
 
+## v1.2.1
+
+[compare changes](https://github.com/BluesYoung-web/create-young-proj/compare/v1.2.0...v1.2.1)
+
+### 🚀 Enhancements
+
+- 🚀 日志 & 自适应跳转优化 ([1325277](https://github.com/BluesYoung-web/create-young-proj/commit/1325277))
+- 🚀 打印请求者 ua, ip ([59fc41d](https://github.com/BluesYoung-web/create-young-proj/commit/59fc41d))
+- 🚀 缓存配置 ([3573531](https://github.com/BluesYoung-web/create-young-proj/commit/3573531))
+
+### 🔥 Performance
+
+- 🔥 缓存机制优化 ([cbe8bb5](https://github.com/BluesYoung-web/create-young-proj/commit/cbe8bb5))
+
+### ❤️ Contributors
+
+- 张扬 <bluesyoung_web@163.com>
+
 ## v1.2.0
 
 [compare changes](https://github.com/BluesYoung-web/create-young-proj/compare/v1.1.0...v1.2.0)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-young-proj",
   "type": "module",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "create project from template",
   "author": "BluesYoung-web",
   "license": "MIT",

package/template-nuxt-admin/server/plugins/env.ts

@@ -1,7 +1,7 @@
 /*
  * @Author: zhangyang
  * @Date: 2022-12-30 17:19:42
- * @LastEditTime: 2023-11-07 14:38:26
+ * @LastEditTime: 2023-11-10 16:09:24
  * @Description:
  */
 import { resolve } from 'node:path'
@@ -48,13 +48,19 @@ export default defineNitroPlugin(async (nitroApp) => {
       delete config[key]
   }
 
+  // 仅打包之后格式化日志
+  if (process.env.NODE_ENV !== 'development')
+    useYoungLogger()
+
   console.log('------------------------读取配置文件------------------------')
   console.log(config)
   console.log('-------------------------------------------------------------')
 
-  // 仅打包之后格式化日志
-  if (process.env.NODE_ENV !== 'development')
-    useYoungLogger()
+  nitroApp.hooks.hook('request', (event) => {
+    const headers = event.node.req.headers
+    console.log('ua', headers['user-agent'], 'x-forwarded-for', headers['x-forwarded-for'], 'x-real-ip', headers['x-real-ip'])
+  })
+
 
   nitroApp.hooks.hook('render:html', (html, { event }) => {
     // 直接注入环境变量到前端

package/template-nuxt-website/README.md

@@ -27,6 +27,14 @@ navigateTo({
 
 **`asstes` 内的图片不得大于 4k**，超过大小的图片需要转换为 `webp` 后上传至 `cdn`
 
+### 接口缓存基准时间
+
+开发时可以修改 `nuxt.config.ts -> runtimeConfig -> public -> cacheTime` 的值
+
+部署时调整 `boot.mjs` 中 `NUXT_PUBLIC_CACHE_TIME` 的默认值
+
+**系统环境变量 `NUXT_PUBLIC_CACHE_TIME` 优先级最高！！！**
+
 ## 特性
 
 - 基于 [@nuxtjs/device](https://github.com/nuxt-modules/device) 的设备判断

package/template-nuxt-website/boot.mjs

@@ -1,12 +1,21 @@
 /*
  * @Author: zhangyang
  * @Date: 2022-09-07 09:31:12
- * @LastEditTime: 2023-05-26 11:21:19
+ * @LastEditTime: 2023-11-10 09:41:43
  * @Description:
  */
 (async () => {
   const env = process.env.DEPLOY_ENV
   const listenPort = process.env.LISTEN_PORT || 3003
+
+  /**
+   * !!! 接口缓存时间基准配置，默认 60s
+   */
+  const NUXT_PUBLIC_CACHE_TIME = 60
+
+  if (!(+process.env.NUXT_PUBLIC_CACHE_TIME > 0))
+    process.env.NUXT_PUBLIC_CACHE_TIME = NUXT_PUBLIC_CACHE_TIME
+
   console.log('当前环境：', env)
   console.log('服务监听端口：', listenPort)
 

package/template-nuxt-website/composables/config.ts

@@ -1,11 +1,17 @@
 /*
  * @Author: zhangyang
  * @Date: 2023-07-26 11:48:46
- * @LastEditTime: 2023-09-27 12:06:20
+ * @LastEditTime: 2023-11-10 10:27:21
  * @Description:
  */
 /**
- * 接口缓存时间，单位为 s
- * todo: 正式部署前按需修改
+ * 接口缓存基准时间，单位为 s
  */
-export const NUXT_PUBLIC_CACHE_TIME = 1
+export const NUXT_PUBLIC_CACHE_TIME = +useRuntimeConfig().public.cacheTime
+
+if (!NUXT_PUBLIC_CACHE_TIME) {
+  console.error('配置异常：缓存基准时长 NUXT_PUBLIC_CACHE_TIME', NUXT_PUBLIC_CACHE_TIME)
+  process.exit(1)
+}
+
+console.log('缓存基准时长 NUXT_PUBLIC_CACHE_TIME：', NUXT_PUBLIC_CACHE_TIME, '秒')

package/template-nuxt-website/nuxt.config.ts

@@ -1,7 +1,7 @@
 /*
  * @Author: zhangyang
  * @Date: 2023-09-21 15:57:55
- * @LastEditTime: 2023-11-08 10:56:04
+ * @LastEditTime: 2023-11-10 14:55:01
  * @Description:
  */
 
@@ -88,6 +88,14 @@ export default defineNuxtConfig({
     defaultImage: '/svg/image_placeholder.svg',
   },
 
+  'routeRules': {
+    /**
+     * 页面缓存，配置具体数值会被作为 max-age 的值，不过貌似 true 就足够了
+     * 根据具体情况自行调整各个路径的对应配置
+     */
+    '*': { swr: true },
+  },
+
   'vite': {
     build: {
       // 兼容钉钉浏览器
@@ -95,4 +103,12 @@ export default defineNuxtConfig({
       sourcemap: false,
     },
   },
+  'runtimeConfig': {
+    public: {
+      /**
+       * 接口缓存基准时间，会被 NUXT_PUBLIC_CACHE_TIME 环境变量覆盖
+       */
+      cacheTime: 10,
+    },
+  },
 })

package/template-nuxt-website/server/api/get_footer_info.get.ts

@@ -1,7 +1,7 @@
 /*
  * @Author: zhangyang
  * @Date: 2023-10-07 16:02:03
- * @LastEditTime: 2023-11-08 10:32:38
+ * @LastEditTime: 2023-11-10 15:02:38
  * @Description:
  */
 import { NUXT_PUBLIC_CACHE_TIME } from '~~/composables/config'
@@ -47,6 +47,6 @@ export default cachedEventHandler(async () => {
     return false
   }
 }, {
-  maxAge: NUXT_PUBLIC_CACHE_TIME,
+  maxAge: NUXT_PUBLIC_CACHE_TIME * 10,
   swr: true,
 })

package/template-nuxt-website/server/api/get_gray_status.get.ts

@@ -1,7 +1,7 @@
 /*
  * @Author: zhangyang
  * @Date: 2023-06-07 12:06:48
- * @LastEditTime: 2023-11-08 10:30:59
+ * @LastEditTime: 2023-11-10 15:02:45
  * @Description:
  */
 import { NUXT_PUBLIC_CACHE_TIME } from '~~/composables/config'
@@ -33,6 +33,6 @@ export default cachedEventHandler(async (event) => {
     }
   }
 }, {
-  maxAge: NUXT_PUBLIC_CACHE_TIME * 3,
+  maxAge: NUXT_PUBLIC_CACHE_TIME * 5,
   swr: true,
 })

package/template-nuxt-website/server/api/get_head_nav.get.ts

@@ -1,7 +1,7 @@
 /*
  * @Author: zhangyang
  * @Date: 2023-06-07 14:43:38
- * @LastEditTime: 2023-11-08 09:53:14
+ * @LastEditTime: 2023-11-10 15:02:52
  * @Description:
  */
 import { NUXT_PUBLIC_CACHE_TIME } from '~~/composables/config'
@@ -33,6 +33,6 @@ export default cachedEventHandler(async () => {
     return false
   }
 }, {
-  maxAge: NUXT_PUBLIC_CACHE_TIME,
+  maxAge: NUXT_PUBLIC_CACHE_TIME * 5,
   swr: true,
 })

package/template-nuxt-website/server/api/get_home_banner.get.ts

@@ -1,7 +1,7 @@
 /*
  * @Author: zhangyang
  * @Date: 2023-10-07 17:43:38
- * @LastEditTime: 2023-10-09 12:08:35
+ * @LastEditTime: 2023-11-10 15:03:01
  * @Description:
  */
 import { NUXT_PUBLIC_CACHE_TIME } from '~~/composables/config'
@@ -23,6 +23,6 @@ export default cachedEventHandler(async (event) => {
     return false
   }
 }, {
-  maxAge: NUXT_PUBLIC_CACHE_TIME,
+  maxAge: NUXT_PUBLIC_CACHE_TIME * 3,
   swr: true,
 })

package/template-nuxt-website/server/api/get_seo_info.get.ts

@@ -1,7 +1,7 @@
 /*
  * @Author: zhangyang
  * @Date: 2023-06-07 14:29:59
- * @LastEditTime: 2023-11-08 09:51:06
+ * @LastEditTime: 2023-11-10 15:03:09
  * @Description:
  */
 import { NUXT_PUBLIC_CACHE_TIME } from '~~/composables/config'

package/template-nuxt-website/server/plugins/init.ts

@@ -1,7 +1,7 @@
 /*
  * @Author: zhangyang
  * @Date: 2022-12-30 17:19:42
- * @LastEditTime: 2023-11-08 10:52:46
+ * @LastEditTime: 2023-11-10 14:59:37
  * @Description:
  */
 import { resolve } from 'node:path'
@@ -9,6 +9,9 @@ import { loadConfig } from 'c12'
 import { useYoungLogger } from '@bluesyoung/logger'
 
 export default defineNitroPlugin(async (nitroApp) => {
+  const IS_PROD = process.env.NODE_ENV !== 'development'
+  console.log('🚀 ~ file: init.ts:13 ~ IS_PROD:', IS_PROD)
+
   const env = (process.env.DEPLOY_ENV as 'dev' | 'test' | 'online') || 'dev'
   const { config } = await loadConfig<Record<string, any>>({
     name: env,
@@ -17,7 +20,7 @@ export default defineNitroPlugin(async (nitroApp) => {
       // 优先读取环境变量中的版本信息(自己打的 Tag)
       NUXT_PUBLIC_CURRENT_VERSION: process.env.PROJECT_VERSION || 'v0.0.1',
       // 日志等级
-      CONSOLA_LEVEL: 1,
+      CONSOLA_LEVEL: 3,
       // 此处可以放置通用的环境变量
       VITE_WECHAT_APPID: 'todo: 微信公众号appid',
       VITE_OSS_URL: `https://master-web-cdn.laiyouxi.com/platform_index/${env}/`,
@@ -45,25 +48,19 @@ export default defineNitroPlugin(async (nitroApp) => {
       delete config[key]
   }
 
-  console.log('------------------------读取配置文件------------------------')
-  console.log(config)
-  console.log('-------------------------------------------------------------')
-
-  const IS_PROD = process.env.NODE_ENV !== 'development'
-  console.log('🚀 ~ file: init.ts:53 ~ IS_PROD:', IS_PROD)
-
   if (IS_PROD) {
     // 格式化日志
-    const { consola } = useYoungLogger()
-    const logger = consola.create({
-      level: +process.env.CONSOLA_LEVEL!,
-    })
-    logger.wrapConsole()
+    useYoungLogger()
   }
 
-  nitroApp.hooks.hook('render:html', async (html, { event }) => {
+  console.log('------------------------读取配置文件------------------------')
+  console.log(config)
+  console.log('-------------------------------------------------------------')
+
+  nitroApp.hooks.hook('request', (event) => {
     const ua = event.node.req.headers['user-agent']
 
+    console.log('ua', ua, 'x-forwarded-for', event.node.req.headers['x-forwarded-for'], 'x-real-ip', event.node.req.headers['x-real-ip'])
     console.log('jump status: ', !config!.DISABLE_AUTO_LOCATION, typeof !config!.DISABLE_AUTO_LOCATION)
 
     if (ua && (IS_PROD && !config!.DISABLE_AUTO_LOCATION)) {
@@ -76,18 +73,19 @@ export default defineNitroPlugin(async (nitroApp) => {
         console.log('🚀 ~ file: init.ts:64 ~ nitroApp.hooks.hook ~ 手机访问 PC 网址:')
         event.node.res.setHeader('Location', process.env.VITE_WEBSITE_MOBILE! + event.node.req.url)
         event.node.res.statusCode = 301
-        return
+        event.node.res.end()
       }
       else if (!isMobile && fromMobile) {
         // PC 访问手机网址
         console.log('🚀 ~ file: init.ts:72 ~ nitroApp.hooks.hook ~ PC 访问手机网址:')
         event.node.res.setHeader('Location', process.env.VITE_WEBSITE_PC! + event.node.req.url)
         event.node.res.statusCode = 301
-        return
+        event.node.res.end()
       }
     }
+  })
 
-    // 网站置灰
+  nitroApp.hooks.hook('render:html', async (html, { event }) => {
     try {
       const {
         is_gray,