Giters

Chacix / seezoon-stack

一款基于当前最前沿的前端（Vue3 + Vite + Antdv）和后台（Spring boot）实现的低代码开发平台。

Home Page:https://stack.seezoon.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

seezoon

Seezoon Stack GitHub stars GitHub forks

简介

Seezoon Stack 以快速开发为目的，在开发速度和代码结构上做出一定取啥，无论如何，你将看到最地道的 Java 常用开发框架使用。该项目采用主流开发框架，无论打包、编译、部署都按着大公司的标准完成并不断逐步完善。

💻 在线演示

https://stack.seezoon.com/

账号：admin

密码：123456

部分效果图：

image-20210422205522263

image-20210422205553804

image-20210422205738456

技术选型

Seezoon Stack 采用当下最前沿前后端的技术栈完成。

后台主要框架：

框架名称 框架地址 说明
Spring Boot https://spring.io/projects/spring-boot 自动装配
Spring Session Data Redis https://spring.io/projects/spring-session-data-redis 登录态管理
Spring Security https://spring.io/projects/spring-security 登录及权限控制
Mybatis https://mybatis.org/mybatis-3/zh/index.html 持久层
Springfox https://github.com/springfox/springfox openAPI 3 文档

特性

  • JSR303 验证、标准API模型，错误码、异常处理封装
  • 请求埋点，返回头添加X-Trace-Id，通过MDC在日志中埋入线程ID;
  • Redis 封装，序列化
  • RestTemplate 线程池、证书请求及默认属性约定
  • Spring Boot 异步线程配置
  • 跨域配置
  • 基于openAPI 3.0 规范的自动生成文档
  • 前后端一体化代码生成
  • 登录及权限控制
  • 文件处理，支持磁盘文件和阿里云OSS
  • 国际化

优先级较低的功能(TODO)：

  • 阿里云短信
  • Excel 处理
  • 微信公众号、小程序相关，登录，支付等常用封装
  • 通用数据权限
  • 云原生部署及编排文档

前台主要框架：

框架名称 框架地址 说明
Vue 3 https://v3.cn.vuejs.org/guide/introduction.html 双向绑定
Vite https://cn.vitejs.dev/ 构建工具
Ant Design Vue 2 https://2x.antdv.com/components/overview-cn/ 组件
TypeScript 4 https://www.typescriptlang.org/zh/ JavaScript 超集
Windi Css https://windicss.org/guide/ css 辅助类
Iconify https://iconify.design/ 图标库

前端框架 fork Vue vben admin 2.0，定期会合并上游特性，具体组件请参考 Vben admin 文档。在此也感谢Vben admin 对该项目提供的帮助。

前端主要采用Ant Design Vue 2 作为主要组件库，降低学习成本，主体框架均为TypeScript，业务功能采用JavaScript编写，针对快速开发JavaScript 代码量较为简洁，速度较快。

环境准备

  • JDK 1.8 + （建议11）
  • Maven 3 +
  • Node 12 +
  • Yarn（安装完node，可用npm install -g yarn）
  • Redis
  • Mysql 5.7 + (建议8)

IDEA 配置

建议都配置，可以实现Java 和前端代码自动格式化，统一编码标准。

在IDEA 中分别安装插件

【必须】Lombok 简化代码神器，安装即可

【可选】Save Actions 保存代码自动格式化，配置如下图

image-20210422201011887

【可选】Eclipse Code Formatter 使用阿里P3C 格式化规范，已放置在build/eclipse-codestyle.xml，配置如下图

image-20210422201421446

【可选】EsLint (IDEA 内置)前端格式化，配置如下图

image-20210422201755954

🚀 快速开始

代码下载

可以通过 IDEA File->New->Project From Version Control 导入，也可以通过命令下载后导入。

建议fork 后到自己仓库后再导入，方便后续同步更新。

git clone https://github.com/734839030/seezoon-stack.git

工程结构

​```
.
└── seezoon-stack   parent工程
    ├── build 构建所需文件
    │   ├── assembly    生成产出物结构
    │   │   ├── bin     项目脚本
    │   │   ├── conf    配置目录
    │   │   ├── logs    日志目录
    │   │   └── assembly.xml     maven assembly 打包插件描述文件(不打包到产出物)
    │   ├── build.sh    构建脚本
    │   ├── eclipse-codestyle.xml  P3C代码格式,可以自行更新
    │   ├── maven-settings.xml     maven的setting配置(可选)
    │   └── mybatis-generator-config.xml  原生mybatis-generator 描述文件(可选)
    ├── db DB脚本目录
    ├── doc 项目文档及资料维护目录
    ├── seezoon-admin-server  管理端服务
    ├── seezoon-admin-web  后台页面目前fork上游,代码库单独维护稳定后合并
    ├── seezoon-dao    DAO层，方便管理端和C端引用
    ├── seezoon-framework  管理端和C端通用框架层(基础中间件,参数验证，安全控制)
    ├── seezoon-generator  通用代码生成器，可以单独使用也可以供其他组件继承使用
    └── seezoon-user-server  C端服务端TODO
​```

后台

  • 初始化DB脚本

    脚本见db/seezoon-stack.sql

  • 配置seezoon-admin-server

    在如下配置文件配置DB和Redis账号密码

    seezoon-admin-server/src/main/resources/application-local.properties

  • IDEA中启动后台

执行如下类中Main方法(如果报依赖错误，可以执行parent 工程mvn package)

​ seezoon-admin-server/src/main/java/com/seezoon/admin/AdminMain.java

前台

  • 安装依赖并启动

    cd seezoon-stack/seezoon-admin-web
yarn install
yarn serve 

# 访问地址
http://localhost:3100/

  • 本地测试文件服务器(可选)

    cd seezoon-admin-web/test/server/upload
yarn install
yarn start

# 管理端上传文件后，可以直接访问地址static目录静态文件
http://localhost:3001/static/xxxx

生产环境部署

线上目录结构，

/data/
│── cert
├── seezoon-admin-server  # 后台产出物
│   ├── bin
│   ├── conf
│   ├── logs
│   └── work
├── seezoon-admin-web    # 前端产出物
│   ├── assets
│   └── resource
└── upload-server  文件上传目录，默认使用磁盘文件，使用OSS则不需要.

😇 手工部署-后台

线上环境安装Java 1.8 + ，推荐11。

采用maven-assembly-plugin生成构建物，可以直接生成生产部署的目录结构，方便DevOps 集成.

cd seezoon-admin-server
mvn clean package

产出物目录

seezoon-admin-server/target/seezoon-admin-server

只需要维护产出物conf 目录的application.properties 即可，然后就可以发布了。

配置文件与环境分离，maven-jar-plugin 打包产出物jar会排出resources目录如下文件：

application-local.properties
logback-spring.xml

如果不介意各个环境配置都在工程中那就很方便，使用spring boot 提供的--spring.profiles.active，在启动命令中选择配置文件。

image-20210423121842460

😇 手工部署-前台

cd seezoon-admin-web
yarn build

产出物

seezoon-admin-web/dist 中文件发布到线上nginx 目录即可，该工程nginx 配置如下，仅供参考。

upstream seezoon-admin-server {
    server 127.0.0.1:8080 max_fails=3 fail_timeout=10s;
}

server {
    listen       80;
    server_name  stack.seezoon.com;
    rewrite ^(.*)$  https://$host$1 permanent;
}

server {
    listen       443;
    server_name  stack.seezoon.com;
    ssl on;
    ssl_certificate   /data/cert/stack.seezoon.com.pem; 
    ssl_certificate_key  /data/cert/stack.seezoon.com.key;
    ssl_session_timeout 5m;
    ssl_ciphers ECDHE-RSA-AES128-GCM-SHA256:ECDHE:ECDH:AES:HIGH:!NULL:!aNULL:!MD5:!ADH:!RC4;
    ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
    ssl_prefer_server_ciphers on;

    # api
    location ^~ /api/ {
        proxy_redirect off;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Real-PORT $remote_port;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_pass http://seezoon-admin-server/;
    }
    # 文件服务
    location ^~ /file/ {
        access_log off;
        alias /data/upload-server/;
    }

    # 静态资源
    location / {
        access_log off;
        root /data/seezoon-admin-web/;
        index index.html index.htm;
    }

}

可选静态资源压缩配置，放在nginx.conf http 节点下。

# 打开gzip 效果更佳
gzip on;
gzip_min_length 1k;
gzip_buffers 4 16k;
gzip_http_version 1.0;
gzip_comp_level 6;
gzip_types text/plain application/javascript application/x-javascript text/css application/xml text/javascript application/x-httpd-php image/jpeg image/gif image/png;
gzip_vary off;
gzip_disable "MSIE [1-6]\.";

🏄🏾‍♂️ （推荐）云效2020 部署

不是给阿里打广告，是真的好用，个人使用基本免费，可以使用完整DevOps功能，需求看板，测试计划、灰度发布，回退等。

后台最短路径**流水线 **配置，添加源代码->构建->主机部署(不要求是阿里主机).

image-20210423130133351

主机部署，部署脚本见build/yunxiao/java-deploy.sh，主机如果conf目录存在了，则不会覆盖，后面会讲用配置中心的方式(小项目依赖多了划不来，可以当学习使用)。

image-20210423130548116

前台最短路径

image-20210423144532907

部署脚本见build/yunxiao/page-deploy.sh

image-20210423144643042

最终的效果就是动动小手👌就部署了，也可以使用git hooks，基于代码和分支变动自动触发，非常酸爽。

image-20210423174851689

🤴🏽 阿里云ACM 应用配置管理

没错你猜对了，这个是也是免费的，没有任何附加条件，也是流行Nacos 实现，可以配置比对，版本管理，灰度推送，推送轨迹等便捷功能。

上面的后台部署需要手工处理配置文件比较麻烦，这个章节看项目需要，可以彻底剥离配置文件，大项目一般是有配置中心的，可以自己搭建Nacos，这里有免费的当然优先选择现有的，何况代码中没有直接依赖。

image-20210423150358035

该项目已经集成nacos-config-spring-boot-starter。静默开启和关闭，加上Nacos 配置则远程优先本地，不加则还是传统方式。

这里为了降低依赖没有使用Nacos的注解，所以不具备自动刷新能力，发完配置需要重启生效。

# 在这个文件中补全Nacos 的配置
build/assembly/conf/application.properties

# 免费阿里云配置中心nacos https://acmnext.console.aliyun.com/
# 只需添加了下列配置，就可以读取配置中心变量，默认spring自带注解不刷新，发布后应用需要重启，如需自动刷新，请用Nacos自带注解
# 容器中使用把可变参数值做成环境变量即可
nacos.config.bootstrap.enable=true
nacos.config.remote-first=true
nacos.config.bootstrap.log-enable=true
nacos.config.auto-refresh=true
nacos.config.type=properties
nacos.config.data-id=com.seezoon
nacos.config.group=seezoon-admin-server
nacos.config.endpoint=acm.aliyun.com
# 很奇葩是这uuid ，不想写名字
nacos.config.namespace=555dabb9-1d2a-4ecd-9069-c377f7823236
# 推荐使用 RAM 用户的 accessKey 和 secretKey
nacos.config.access-key=xxx
nacos.config.secret-key=xxx

功能介绍

持续完善中......

常用开发指南

持续完善中......

About

一款基于当前最前沿的前端（Vue3 + Vite + Antdv）和后台（Spring boot）实现的低代码开发平台。

https://stack.seezoon.com

License:MIT License

Languages

Language:Java 87.8%Language:TypeScript 3.5%Language:JavaScript 2.6%Language:Less 2.2%Language:Smarty 1.8%Language:PLpgSQL 1.1%Language:CSS 0.5%Language:Shell 0.2%Language:HTML 0.2%Language:Dockerfile 0.0%