VB.net 2010 视频教程 VB.net 2010 视频教程 python基础视频教程
SQL Server 2008 视频教程 c#入门经典教程 Visual Basic从门到精通视频教程
当前位置:
首页 > temp > JavaScript教程 >

  • vane 一个适用于前端打工人的全栈框架,nodejs+vue3+typescript

vane

写这个的初衷是因为每次用node写接口的时候总是需要一些写大一堆的东西, 也有些人把很多接口都放在一个js文件内, 看起来很是杂乱, 后来用到nuxt写的时候, 感觉用文件名来命名接口路径很是方便, 无论是query参数还是params参数,都可以通过文件名来命名, 也可以通过文件夹层级清晰的反映出接口之间的关系(虽然类似nuxt,next这种的框架确实很好,但是好处同样也是坏处,很难完全的前后端分离,不能只写前端,或者后端,而且也不需要再去学习相关的知识), 于是就有了这个项目, 能够节省很大一部分时间, 也能够让接口更加清晰, 也能够让接口更加清晰, 也能够让接口更加清晰, 重要的事情说三遍。
节省下来的时间用来休息和摸鱼多好(不是让你接着内卷的)。
如果真的帮到了你的话,觉得这个项目还不错的话, 可以给我一个star, 也可以给我一个star, 也可以给我一个star, 重要的事情说三遍。

github传送门   https://github.com/Big0range/vane

gitee传送门     https://gitee.com/li_mei_chao/vane

接口文档         https://console-docs.apipost.cn/preview/dc179c71d30711dd/f33af9712a7ab774

Snipaste_2023-06-26_18-07-28.png

技术栈

web
Vue3, TypeScript, Vite node
server
node, TypeScript, express, sequelize, mysql, redis
server进阶
docker, docker-componse, pm2

node版本: ^18
pnpm版本: ^8

服务端

配置hosts

如果是windows的话,请在C:\Windows\System32\drivers\etc\hosts文件中添加以下内容

请替换为自己真实的mysql以及redis数据库ip地址, 192.168.31.202仅为示例










 



192.168.31.202 vane-redis-master







 



192.168.31.202 vane-mysql-master







 



192.168.31.202 vane-mysql-node1







 



192.168.31.202 vane-mysql-node2







安装依赖



npm install -g pnpm (也可以指定版本安装pnpm npm install -g pnpm@8) pnpm install



请勿使用淘宝镜像源,会导致依赖安装失败 还原设置: pnpm config set registry https://registry.npmjs.org/



启动命令



开发环境



启动服务端: pnpm dev:server 启动web端: pnpm dev:client 全部启动: pnpm dev\



正式环境(Centos)



启动服务端


    

  1. 
原生docker部署(不推荐), 会根据Dockerfile文件中配置启动 会执行一个run.sh脚本,可按需求修改
    2. 

  2. 
非docker部署(极不推荐,需要服务器支持node18,并且较为繁琐),可以运行pnpm start:server(请先执行打包命令),需要自己启动以及配置数据库,并且node>=18并不支持Centos7,极力推荐使用docker进行部署
    3. 

  3. 
docker-componse部署(推荐), 一键脚本 sh docker_start.sh all/server/db (参数按需选择all或者server或者db,不传入的话默认为server)

      

    1. 
db: 启动mysql以及redis数据库 如果你是第一次启动的话需要下载GitHub中releases符合自己本地代码版本的数据库文件(版本可在根目录下package.json中查看),并解压到/home/docker-volumes目录下,正确的目录应该是/home/docker-volumes/vane,也可以自己修改db/docker-compose.yml文件中的相关配置,自己配置数据库
      2. 

    2. 
server: 启动node服务端和nginx,默认端口映射为80,如果你想修改的话,请自行修改server/docker-compose.yml文件中的相关配置
      3. 

    3. 
all: 数据库以及服务端全部启动
      4. 

    4. 
建议: 数据库如无修改,启动一次即可
      5. 

    

    4. 




docker 镜像下载问题


    

  1. 
如果你的服务器无法下载docker镜像,请尝试修改docker镜像源,具体操作请自行查询(帖子太多了,没必要写在这里.....)
    2. 

  2. 
如果你尝试修改docker镜像源后,仍然无法下载,在网盘中下载对应的压缩包,docker导入镜像,云盘内有使用说明,按照操作即可 网盘地址 提取码: 8gyc
    3. 




单独打包



如果你有其他的需求,可以单独打包,打包后的文件在dist文件夹下


    

  1. 
打包服务端 pnpm build:server
    2. 

  2. 
打包web端 pnpm build:client
    3. 




环境配置



开发环境配置



node>=18, pnpm>=8, mysql:5.7, redis:6.2



正式环境



node>=16.14.0(如果可以安装18版本的最好,16版本只是能保证基本的安装依赖), mysql, redis, pnpm>=8,docker(可选), docker-componse(可选)



配置env文件



在server文件夹下创建.env文件,并按照.env.example文件中的格式进行配置



添加接口路由



路由添加



在server/src/routes文件夹中添加.ts文件即可,路由会根据所在位置以及文件名自动加载,无需显示引入



文件名示例



routes/user/list.ts => http://localhost:9999/user/list(get请求) routes/user/index.ts => http://localhost:9999/user(get请求) routes/user/list.post.ts => http://localhost:9999/user/list(post请求) routes/user/list[a,b].post.ts => http://localhost:9999/user/list(post请求,并req.params中带有a和b两个参数)



文件内容示例











 



import { Request, Response } from '@/routes/types';







 



export default async function (req: Request, res: Response) {







 



try {







 



/**







 



* 某些操作







 



*/







 



res.ok({







 



message: '操作成功',







 



data: data.Location.split('/images/')[1],







 



});







 



} catch (error) {







 



/**







 



* 失败之后的操作







 



*/







 



res.fail(error);







 



}







 



}







 



 







 



// 中间件 非必填







 



export const middleware = [()=>{}];







 



 







接口白名单(不需要登录鉴权)



系统固定白名单(不可修改)



修改server\src\serve\sys\routes.serve.ts中的constantRouteWhiteList数组, 修改之后需要清空mysql中的sys_routes表和redis中的routeWhitelist缓存,否则无法生效



自定义白名单(可修改)



启动前端服务,在http://localhost:4000/vane/system/white-api中进行配置,无需修改mysql和redis



日志记录



api日志



接口日志会自动记录在server/logs/api文件夹下,文件名为access-${日期}.log



sql日志



sql日志会自动记录在server/logs/sql文件夹下,文件名为sql-${日期}.log



文件上传



本项目使用了腾讯云对象存储,如果您没有腾讯云对象存储的话,请自行修改server/src/server/routes/upload.ts文件中的上传逻辑,并修改client/src/utils/config.ts文件中的CDNURL 远程资源地址



注意事项


    

  1. 

    
mysql使用了一主多从集群模式,如果您仅仅使用一个mysql的话,请修改server/.env文件中的mysql配置,以及server/src/serve/db.ts文件中sequelize的实例初始化代码
    

    2. 

  2. 

    
开发环境下, 默认不启动数据库集群模式,如果需要启动集群模式,请修改server文件夹下的nodemon.json中的NODE_ENV为production
    

    3. 

  3. 

    
虽然使用了pnpm的workspace的模式,但是由于某些原因服务端在打包后,不能正确解析工作区间内的包名,所以禁止在服务端代码内使用工作区间内的包,但是web端可以使用服务端的
    

    4. 




前端



如果你用过vue2版本的vue-admin的话,上手应该会非常快,因为本项目的前端是模仿vue-admin的vue3版本,并且使用了typescript,所以如果你不熟悉vue3的话,建议先学习一下vue3的基础知识



目录结构











 



|--




    











相关教程