huangdengfeng/admin-beacon

基于Spring boot 3 + Spring Security 的基础管理后台。包含完整用户管理，RBAC权限控制，运维脚本等基础开箱即用特性。

简介

Admin Beacon 是一个通用管理后台开发脚手架。主要包含用户管理、RBAC权限控制、生产部署脚本等基础特性。

采用DDD架构及CQRS开发理念。 golang 版本同步更新中 https://github.com/huangdengfeng/go-admin-beacon

运行截图

登录 首页 用户 角色

技术选型

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

后台主要框架：

框架名称	框架地址	说明
Spring Boot3	https://spring.io/projects/spring-boot	自动装配
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 文档

环境准备

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

🚀 快速开始

代码下载

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

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

git clone https://github.com/huangdengfeng/admin-beacon.git

后台

• 初始化DB脚本

  脚本见build/sql/all.sql

• 配置admin-beacon

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

  /src/main/resources/application-local.properties

前台

https://github.com/huangdengfeng/admin-beacon-web

• 安装依赖并启动

  cd admin-beacon-web
  yarn install
  yarn dev 
  
  # 访问地址
  http://localhost:3002/
  

生产环境部署

线上目录结构，

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

😇 手工部署-后台

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

cd admin-beacon
mvn clean package

产出物目录

admin-beacon/target/admin-beacon

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

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

application-local.properties

😇 手工部署-前台

cd admin-beacon-web
yarn build

产出物

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

upstream admin-beacon {
    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://admin-beacon/;
    }
    # 文件服务
    location ^~ /file/ {
        access_log off;
        alias /data/upload-server/;
    }

    # 静态资源
    location / {
        access_log off;
        root /data/admin-beacon-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]\.";

如何贡献

非常欢迎你的加入！提一个 Issue 或者提交一个 Pull Request。

Pull Request：

1. Fork 代码! (同步上游：git pull https://github.com/huangdengfeng/admin-beacon.git master)
2. 创建自己的分支: git checkout -b feat/xxxx
3. 提交你的修改: git commit -m 'feat(function): add xxxxx'
4. 推送您的分支: git push origin feat/xxxx
5. 提交pull request

Git 贡献提交规范

参考规范 (Angular)

- `feat` 增加新功能
- `fix` 修复问题/BUG
- `style` 代码风格相关无影响运行结果的
- `perf` 优化/性能提升
- `refactor` 重构
- `revert` 撤销修改
- `test` 测试相关
- `docs` 文档/注释
- `chore` 依赖更新/脚手架配置修改等
- `workflow` 工作流改进
- `ci` 持续集成
- `types` 类型定义文件更改
- `wip` 开发中