commit cdee21ee8e920f09add4727aa6150525066ad44e Author: gin Date: Thu May 7 18:39:00 2026 +0800 feat: initial commit diff --git a/.githooks/commit-msg b/.githooks/commit-msg new file mode 100755 index 0000000..31f3e97 --- /dev/null +++ b/.githooks/commit-msg @@ -0,0 +1,44 @@ +#!/bin/sh + +commit_msg_file="$1" + +if [ ! -f "$commit_msg_file" ]; then + echo "commit-msg hook error: commit message file not found" + exit 1 +fi + +header="$(sed -n '/^[[:space:]]*#/!{/^[[:space:]]*$/!{p;q;}}' "$commit_msg_file")" + +if [ -z "$header" ]; then + echo "Invalid commit message: empty message" + exit 1 +fi + +case "$header" in + Merge\ *|Revert\ *|fixup!\ *|squash!\ *) + exit 0 + ;; +esac + +type_pattern="feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert|wip|workflow|types|release" +commit_pattern="^($type_pattern)($[a-z0-9][a-z0-9._/-]*$)?!?: .{1,}$" + +if ! printf '%s\n' "$header" | grep -Eq "$commit_pattern"; then + echo "Invalid commit message format." + echo "" + echo "Expected Conventional Commits format:" + echo " [optional scope][optional !]: " + echo "" + echo "Allowed types:" + echo " feat, fix, docs, style, refactor, perf, test, build, ci, chore," + echo " revert, wip, workflow, types, release" + echo "" + echo "Examples:" + echo " feat: add user search" + echo " fix(backend): handle token expiry" + echo " docs(readme): update setup guide" + echo " refactor(web)!: remove legacy auth flow" + exit 1 +fi + +exit 0 diff --git a/.githooks/pre-commit b/.githooks/pre-commit new file mode 100644 index 0000000..0f19083 --- /dev/null +++ b/.githooks/pre-commit @@ -0,0 +1,16 @@ +#!/bin/sh + +if [ -n "$CI" ]; then + exit 0 +fi + +staged_files="$(git diff --cached --name-only --diff-filter=ACMR)" + +if printf '%s\n' "$staged_files" | grep -q '^frontend/'; then + if ! command -v pnpm >/dev/null 2>&1; then + echo "pre-commit hook error: pnpm is required for frontend checks" + exit 1 + fi + + pnpm --dir frontend lint +fi diff --git a/README.md b/README.md new file mode 100644 index 0000000..cae1036 --- /dev/null +++ b/README.md @@ -0,0 +1,104 @@ +# Simple Template + +## Quick Start + +This project contains: + +- `backend`: Spring Boot admin API. +- `frontend/web`: Vite + Vue 3 admin frontend. +- `frontend/app`: Taro + Vue 3 app frontend. + +The local development flow starts MySQL and Redis with Docker, then runs the +backend and web frontend locally. + +### Requirements + +- JDK 8+ +- Docker Desktop or Docker Engine with Compose +- Node.js +- pnpm + +### Start Infrastructure + +The development backend is configured to use the same defaults as +`backend/docker-compose.yml`: + +- MySQL: `localhost:3306`, user `root`, password `root123` +- Redis: `localhost:6379`, password `redis123` +- Database name: `agileboot_pure` + +You can start MySQL and Redis manually: + +```bash +cd backend +docker compose up -d +``` + +On a fresh Docker volume, Compose creates the MySQL database `agileboot_pure`. +Import the SQL files under `backend/sql/` before starting the backend. + +### Install Frontend Dependencies + +```bash +cd frontend +pnpm install +``` + +### Start Backend and Web Frontend + +Start the backend: + +```bash +cd backend +./mvnw -pl agileboot-admin -am spring-boot:run +``` + +Start the web frontend: + +```bash +cd frontend +pnpm dev:web +``` + +- Backend: `http://localhost:8080` +- Frontend: Vite output, usually `http://localhost:80/` + +The frontend development proxy maps `/dev-api` to `http://localhost:8080`. + +Optional app commands: + +```bash +cd frontend +pnpm dev:app:weapp +pnpm dev:app:h5 +``` + +## Git Hooks + +This repository uses `.githooks` as the single Git hooks entrypoint. + +```bash +git config core.hooksPath .githooks +``` + +The frontend workspace uses pnpm: + +```bash +cd frontend +pnpm install +pnpm dev:web +pnpm build:web +pnpm dev:app:weapp +pnpm build:app:weapp +pnpm lint +pnpm typecheck +``` + +## Frontend + +`frontend` is a pnpm workspace: + +- `web`: Vite + Vue 3 admin frontend. +- `app`: Taro + Vue 3 app frontend. + +Shared engineering configuration lives in `frontend` root. Subprojects should extend the shared TypeScript, ESLint, Stylelint, Prettier, commitlint, and lint-staged configuration instead of duplicating it. diff --git a/backend/.github/ISSUE_TEMPLATE/bug_report.md b/backend/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..ab0e815 --- /dev/null +++ b/backend/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,36 @@ +--- +name: Bug 报告 +about: 创建BUG报告以改进项目 +title: '' +labels: '' +assignees: '' + +--- + +**BUG描述** +关于BUG清晰简洁的描述。 + +**复现步骤** +详细的复现步骤。 + + +**正确的行为** +你认为这个修复这个BUG后，正确的行为应该是什么。 + + +**详细截图** +如果可以的话，请添加截图以帮助调查BUG. + +**桌面端:** + - 操作系统: [例如. iOS] + - 浏览器及版本 [例如. chrome 11] + - 项目版本 [例如. 1.6.0] + +**手机端:** + - 设备: [例如. iPhone6] + - 操作系统: [例如. iOS8.1] + - 浏览器及版本 [例如.safari 8] + - 项目版本 [例如. 1.6.0] + +**Additional context** +任何其他你认为有助于排查错误的信息，或者你的猜测。 diff --git a/backend/.github/ISSUE_TEMPLATE/feature_request.md b/backend/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..913a980 --- /dev/null +++ b/backend/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: 功能建议 +about: 关于该项目的建议 +title: '' +labels: '' +assignees: '' + +--- + +**您的功能请求是否与问题相关？请描述。** +清楚简明地描述问题所在。 + +**描述您想要的解决方案** +对您所设想的问题的清晰简洁的描述。 + +**描述您考虑过的替代方案** +对您考虑过的任何替代解决方案或功能的清晰简洁的描述。 + +**附加上下文** +在此处添加有关功能请求的任何其他上下文或屏幕截图。 diff --git a/backend/.github/workflows/ci-cd.yml b/backend/.github/workflows/ci-cd.yml new file mode 100644 index 0000000..4a7a5a7 --- /dev/null +++ b/backend/.github/workflows/ci-cd.yml @@ -0,0 +1,116 @@ +# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time +# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-maven + +# 权限声明，确保 workflow 有权限写 checks 和 security-events +permissions: + contents: read + checks: write + security-events: write + +name: Java CI with Maven + +on: + push: + branches: [ "main" ] + paths-ignore: + - 'README.md' + - 'LICENSE' + - '.gitignore' + - '.gitattributes' + - 'picture' + pull_request: + branches: [ "main" ] + workflow_dispatch: + +jobs: + build: + runs-on: ubuntu-latest + timeout-minutes: 30 + strategy: + matrix: + java-version: ['8', '17', '21'] + fail-fast: false + + name: Build with Java ${{ matrix.java-version }} + + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 + + - name: Set up JDK ${{ matrix.java-version }} + uses: actions/setup-java@v3 + with: + java-version: ${{ matrix.java-version }} + distribution: 'temurin' + cache: 'maven' + + # 优化Maven本地仓库缓存策略 + - name: Cache Maven packages + uses: actions/cache@v3 + with: + path: ~/.m2 + key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}-${{ matrix.java-version }} + restore-keys: | + ${{ runner.os }}-m2- + + # 编译和测试：去掉failOnWarning，避免因为警告导致失败 + - name: Build and Test with Maven + run: | + mvn -B verify --file pom.xml -Dmaven.test.failure.ignore=false -Dgpg.skip -Dmaven.javadoc.skip=false + env: + MAVEN_OPTS: -Xmx4g -XX:MaxMetaspaceSize=1g + MAVEN_CLI_OPTS: "--batch-mode --errors --fail-at-end --show-version" + + - name: Publish Test Report + uses: mikepenz/action-junit-report@v4 + if: success() || failure() + with: + report_paths: '**/target/surefire-reports/TEST-*.xml' + detailed_summary: true + include_passed: true + fail_on_failure: true + + - name: Run SonarQube Analysis + if: matrix.java-version == '17' && github.event_name != 'pull_request' && github.ref == 'refs/heads/main' + continue-on-error: true + run: | + if [[ ! -z "${{ secrets.SONAR_TOKEN }}" ]]; then + mvn sonar:sonar \ + -Dsonar.projectKey=agileboot \ + -Dsonar.organization=${{ secrets.SONAR_ORGANIZATION || 'default' }} \ + -Dsonar.host.url=${{ secrets.SONAR_HOST_URL || 'https://sonarcloud.io' }} \ + -Dsonar.login=${{ secrets.SONAR_TOKEN }} \ + -Dsonar.java.source=${{ matrix.java-version }} + else + echo "Skipping SonarQube analysis - SONAR_TOKEN not configured" + fi + + # 上传构建产物，if-no-files-found 改为 warn + - name: Upload Build Artifacts + uses: actions/upload-artifact@v4 + with: + name: agileboot-artifacts-java-${{ matrix.java-version }} + path: | + **/target/*.jar + !**/target/original-*.jar + retention-days: 5 + if-no-files-found: warn + + # # 只在 Java 17 版本上更新依赖图（权限和token已修复） + # - name: Update dependency graph + # uses: advanced-security/maven-dependency-submission-action@v4 + # if: matrix.java-version == '17' && success() + # with: + # token: ${{ secrets.GITHUB_TOKEN }} + + # # 发送构建状态通知 + # - name: Notify Build Status + # if: always() + # uses: rtCamp/action-slack-notify@v2.2.1 + # env: + # SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK || '' }} + # SLACK_CHANNEL: build-notifications + # SLACK_COLOR: ${{ job.status }} + # SLACK_TITLE: Build Status for Java ${{ matrix.java-version }} + # SLACK_MESSAGE: 'Build ${{ job.status }} on Java ${{ matrix.java-version }}' \ No newline at end of file diff --git a/backend/.gitignore b/backend/.gitignore new file mode 100644 index 0000000..f6e0209 --- /dev/null +++ b/backend/.gitignore @@ -0,0 +1,50 @@ +###################################################################### +# Build Tools + +.gradle +/build/ +!gradle/wrapper/gradle-wrapper.jar + +target/ +!.mvn/wrapper/maven-wrapper.jar + +###################################################################### +# IDE + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr + +### JRebel ### +rebel.xml + +### NetBeans ### +nbproject/private/ +build/* +nbbuild/ +dist/ +nbdist/ +.nb-gradle/ + +###################################################################### +# Others +*.log +*.xml.versionsBackup +*.swp + +!*/build/*.java +!*/build/*.html +!*/build/*.xml + +/agileboot-admin/src/main/resources/application-prod.yml + diff --git a/backend/.mvn/wrapper/maven-wrapper.jar b/backend/.mvn/wrapper/maven-wrapper.jar new file mode 100644 index 0000000..cb28b0e Binary files /dev/null and b/backend/.mvn/wrapper/maven-wrapper.jar differ diff --git a/backend/.mvn/wrapper/maven-wrapper.properties b/backend/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 0000000..d36117e --- /dev/null +++ b/backend/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,18 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.3/apache-maven-3.9.3-bin.zip +wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar diff --git a/backend/GoogleStyle.xml b/backend/GoogleStyle.xml new file mode 100644 index 0000000..c2e1d68 --- /dev/null +++ b/backend/GoogleStyle.xml @@ -0,0 +1,567 @@ + + + \ No newline at end of file diff --git a/backend/LICENSE b/backend/LICENSE new file mode 100644 index 0000000..50fca70 --- /dev/null +++ b/backend/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 valarchie + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/backend/README.md b/backend/README.md new file mode 100644 index 0000000..9ca2de4 --- /dev/null +++ b/backend/README.md @@ -0,0 +1,344 @@ + +

+ + + + + + + + + + +

+ + logo +

AgileBoot v2.0.0

基于SpringBoot+Vue3前后端分离的Java快速开发脚手架

+ +## ⚡平台简介⚡ + +AgileBoot是一套开源的全栈精简快速开发平台，毫无保留给个人及企业免费使用。本项目的目标是做一款精简可靠，代码风格优良，项目规范的小型开发脚手架。 +适合个人开发者的小型项目或者公司内部项目使用。也可作为供初学者学习使用的案例。 + + +* 前端是基于优秀的开源项目[Pure-Admin](https://github.com/pure-admin/vue-pure-admin)开发而成。在此感谢Pure-Admin作者。 +* 前端采用Vue3、Element Plus、TypeScript、Pinia。对应前端仓库 [AgileBoot-Front-End](https://github.com/valarchie/AgileBoot-Front-End) ，保持同步更新。 +* 后端采用Spring Boot、Spring Security & Jwt、Redis & MySql、Mybatis Plus、Hutool工具包。 +* 权限认证使用Jwt，支持多终端认证系统。 +* 支持注解式主从数据库切换，注解式请求限流，注解式重复请求拦截。 +* 支持注解式菜单权限拦截，注解式数据权限拦截。 +* 支持加载动态权限菜单，实时权限控制。 +* ***有大量的单元测试，集成测试覆盖确保业务逻辑正确***。 + +***V1.0.0版本使用JS开发，V2.0.0版本使用TS开发***。 +***V1.0.0地址：[后端(AgileBoot-Back-End-Basic)](https://github.com/valarchie/AgileBoot-Back-End-Basic) - [前端(AgileBoot-Front-End-Basic)](https://github.com/valarchie/AgileBoot-Front-End-Basic)*** + +> 有任何问题或者建议，可以在 _Issues_ 中提给作者。 +> +> 您的Issue比Star更重要 +> +> 如果觉得项目对您有帮助，可以来个Star ⭐ + + +## 💥 在线体验 💥 +演示地址： +- www.agileboot.vip +- www.agileboot.cc +> 账号密码：admin/admin123 + + +## 🌴 项目背景 🌴 +业余时间想做一些个人小项目，一开始找了很多开源项目比如Ruoyi / Jeecg / ElAdmin / RenRen-Fast / Guns / EAdmin +最后本项目选择基于Ruoyi项目进行完全重构改造。 +首先非常感谢Ruoyi作者。但是Ruoyi项目存在太多缺陷。 +- 命名比较乱七八糟（很多很糟糕的命名，包括机翻英语乱用） +- 项目分包以及模块比较乱 +- 比较原始的Controller > Service > DAO的开发模式。过于面向过程。 +- 一大堆自己造的轮子，并且没有UT覆盖。 +- 大量逻辑嵌套在if else块当中 +- 值的前后不统一，比如有的地方1代表是，有的地方1代表否 +- 很多很奇怪的代码写法（比如return result > 0 ? true:false.. 一言难尽） +- 业务逻辑不集中，代码可读性较差。 + + +于是我做了大量的重构工作。 + +### 重构内容 + +- 规范： + - 切分不同环境的启动文件 + - 统一设计异常类 + - 统一设计错误码并集中处理异常 + - 统一系统内的变量并集中管理 + - 统一返回模型 + - 引入Google代码格式化模板 + - 后端代码的命名基本都整改OK + - 前端代码的命名也非常混乱，进行了整改 + - 规范系统内的常量 +- 整改： + - 引入hutool包以及guava包去掉大量自己造的轮子，尽可能使用现成的轮子 + - 去除代码中大量的warning + - 引入lombok去除大量getter setter代码 + - 调整日志级别 + - 字典类型数据完全用Enum进行代替 + - 移除SQL注入的Filter，因为迁移到Mybatis Plus就不会有这个注入的问题 + - XSS直接通过JSON序列化进行转义。 + - 替换掉很多Deprecated的类以及配置 + - 替换fastJson为Jackson + - 数据库的整体重构设计，缩减至10张表。 + - 重新设计异步代码 + - 前后端密码加密传输（更严谨的话，还是需要HTTPS） + - 重构权限校验和数据权限校验（直接都通过注解的形式） +- 优化： + - 优化异步服务 + - 优化Redis缓存类，封装各个业务缓存，提供多级缓存实现（Redis+Guava） + - 提供三个层级的缓存供使用者调用（Map,Guava,Redis使用者可依情况选择使用哪个缓存类） + - 权限判断使用多级缓存 + - IP地址查询引入离线包 + - 前端优化字典数据缓存 + - 启动优化 + - i18n支持 + - 优化excel工具类，代码更加简洁 + - 将所有逻辑集中于Domain模块中 + - 切面记录修改者和创建者 + - 统一设置事务 + +## ✨ 使用 ✨ + + +### 开发环境 + +- JDK +- Mysql +- Redis +- Node.js + +### 技术栈 + +| 技术 | 说明 | 版本 | +|----------------|-----------------|-------------------| +| `springboot` | Java项目必备框架 | 2.7 | +| `druid` | alibaba数据库连接池 | 1.2.8 | +| `springdoc` | 文档生成 | 3.0.0 | +| `mybatis-plus` | 数据库框架 | 3.5.2 | +| `hutool` | 国产工具包（简单易用） | 3.5.2 | +| `mockito` | 单元测试模拟 | 1.10.19 | +| `guava` | 谷歌工具包（提供简易缓存实现） | 31.0.1-jre | +| `junit` | 单元测试 | 1.10.19 | +| `h2` | 内存数据库 | 1.10.19 | +| `jackson` | 比较安全的Json框架 | follow springboot | +| `knife4j` | 接口文档框架 | 3.0.3 | +| `Spring Task` | 定时任务框架（适合小型项目） | follow springboot | + + +### 启动说明 + +#### 前置准备：下载前后端代码 + +``` +git clone https://github.com/valarchie/AgileBoot-Back-End +git clone https://github.com/valarchie/AgileBoot-Front-End +``` + +#### 安装好Mysql和Redis + + +#### 后端启动 +``` +1. 生成所需的数据库表 +找到后端项目根目录下的sql目录中的agileboot_xxxxx.sql脚本文件(取最新的sql文件)。导入到你新建的数据库中。 + +2. 在admin模块底下，找到resource目录下的application-dev.yml文件 +配置数据库以及Redis的地址、端口、账号密码 + +3. 在根目录执行mvn install + +4. 找到agileboot-admin模块中的AgileBootAdminApplication启动类，直接启动即可 + +5. 当出现以下字样即为启动成功 + ____ _ _ __ _ _ + / ___| | |_ __ _ _ __ | |_ _ _ _ __ ___ _ _ ___ ___ ___ ___ ___ / _| _ _ | || | + \___ \ | __|/ _` || '__|| __| | | | || '_ \ / __|| | | | / __|/ __|/ _ \/ __|/ __|| |_ | | | || || | + ___) || |_| (_| || | | |_ | |_| || |_) | \__ \| |_| || (__| (__| __/\__ \\__ \| _|| |_| || ||_| + |____/ \__|\__,_||_| \__| \__,_|| .__/ |___/ \__,_| \___|\___|\___||___/|___/|_| \__,_||_|(_) + |_| + +``` + +#### 前端启动 +详细步骤请查看对应前端部分 + +``` +1. pnpm install + +2. pnpm run dev + +3. 当出现以下字样时即为启动成功 + +vite v2.6.14 dev server running at: + +> Local: http://127.0.0.1:80/ + +ready in 4376ms. + +``` + +详细过程在这个文章中：[AgileBoot - 手把手一步一步带你Run起全栈项目(SpringBoot+Vue3)](https://juejin.cn/post/7153812187834744845) + + +> 对于想要尝试全栈项目的前端人员，这边提供更简便的后端启动方式，无需配置Mysql和Redis直接启动 +#### 无Mysql/Redis 后端启动 +``` +1. 找到agilboot-admin模块下的resource文件中的application.yml文件 + +2. 配置以下两个值 +spring.profiles.active: basic,dev +改为 +spring.profiles.active: basic,test + +agileboot.embedded.mysql: false +agileboot.embedded.redis: false +改为 +agileboot.embedded.mysql: true +agileboot.embedded.redis: true + +请注意:高版本的MacOS系统，无法启动内置的Redis + + +3. 找到agileboot-admin模块中的AgileBootAdminApplication启动类，直接启动即可 +``` + + +## 🙊 系统内置功能 🙊 + + +🙂 大部分功能，均有通过 **单元测试** **集成测试** 保证质量。 + +| | 功能 | 描述 | +|-----|-------|---------------------------------| +| | 用户管理 | 用户是系统操作者，该功能主要完成系统用户配置 | +| ⭐ | 部门管理 | 配置系统组织机构（公司、部门、小组），树结构展现支持数据权限 | +| ⭐ | 岗位管理 | 配置系统用户所属担任职务 | +| | 菜单管理 | 配置系统菜单、操作权限、按钮权限标识等，本地缓存提供性能 | +| ⭐ | 角色管理 | 角色菜单权限分配、设置角色按机构进行数据范围权限划分 | +| | 参数管理 | 对系统动态配置常用参数 | +| | 通知公告 | 系统通知公告信息发布维护 | +| 🚀 | 操作日志 | 系统正常操作日志记录和查询；系统异常信息日志记录和查询 | +| | 登录日志 | 系统登录日志记录查询包含登录异常 | +| | 在线用户 | 当前系统中活跃用户状态监控 | +| | 系统接口 | 根据业务代码自动生成相关的api接口文档 | +| | 服务监控 | 监视当前系统CPU、内存、磁盘、堆栈等相关信息 | +| | 缓存监控 | 对系统的缓存信息查询，命令统计等 | +| | 连接池监视 | 监视当前系统数据库连接池状态，可进行分析SQL找出系统性能瓶颈 | + + +## 🐯 工程结构 🐯 + +``` +agileboot +├── agileboot-admin -- 管理后台接口模块（供后台调用） +│ +├── agileboot-api -- 开放接口模块（供客户端调用） +│ +├── agileboot-common -- 精简基础工具模块 +│ +├── agileboot-infrastructure -- 基础设施模块（主要是配置和集成，不包含业务逻辑） +│ +├── agileboot-domain -- 业务模块 +├ ├── user -- 用户模块（举例） +├ ├── command -- 命令参数接收模型（命令） +├ ├── dto -- 返回数据类 +├ ├── db -- DB操作类 +├ ├── entity -- 实体类 +├ ├── service -- DB Service +├ ├── mapper -- DB Dao +├ ├── model -- 领域模型类 +├ ├── query -- 查询参数模型（查询） +│ ├────── UserApplicationService -- 应用服务（事务层，操作领域模型类完成业务逻辑） + +``` + +### 代码流转 + +请求分为两类：一类是查询，一类是操作（即对数据有进行更新）。 + +**查询**：Controller > xxxQuery > xxxApplicationService > xxxService(Db) > xxxMapper +**操作**：Controller > xxxCommand > xxxApplicationService > xxxModel(处理逻辑) > save 或者 update (本项目直接采用JPA的方式进行插入已经更新数据) + +这是借鉴CQRS的开发理念，将查询和操作分开处理。操作类的业务实现借鉴了DDD战术设计的理念，使用领域类，工厂类更面向对象的实现逻辑。 +如果你不太适应这样的开发模式的话。可以在domain模块中按照你之前从Controller->Service->DAO的模式进行开发。it is up to you. + + + +### 二次开发指南 + +假设你要新增一个会员member业务，可以在以下三个模块新增对应的包来实现你的业务 +``` +agileboot +├── agileboot-admin -- +│ ├── member -- 会员模块 +│ +├── agileboot-domain -- +├ ├── member -- 会员模块（举例） +├ ├── command -- 命令参数接收模型（命令） +├ ├── dto -- 返回数据类 +├ ├── db -- DB操作类 +├ ├── entity -- 实体类 +├ ├── service -- DB Service +├ ├── mapper -- DB Dao +├ ├── model -- 领域模型类 +├ ├── query -- 查询参数模型（查询） +│ ├────── MemberApplicationService -- 应用服务（事务层，操作领域模型类完成业务逻辑） +└─ +``` + + + +--- + +## 🎅 技术文档 🎅 +* [AgileBoot - 基于SpringBoot + Vue3的前后端快速开发脚手架](https://juejin.cn/post/7152871067151777829) +* [AgileBoot - 手把手一步一步带你Run起全栈项目(SpringBoot+Vue3)](https://juejin.cn/post/7153812187834744845) +* [AgileBoot - 项目内统一的错误码设计](https://juejin.cn/post/7156062116712022023) +* [AgileBoot - 如何集成内置数据库H2和内置Redis](https://juejin.cn/post/7158793441198112781) +* [AgileBoot - Mybatis Plus 框架项目落地实践总结](https://juejin.cn/post/7202573260659195963) +* [AgileBoot - SpringBoot项目多层级多环境yml设计](https://juejin.cn/post/7205171975647215676) +* [AgileBoot - 项目中多级缓存设计实践总结](https://juejin.cn/post/7208112485764857914) +* 持续输出中 + + + +## 🌻 注意事项 🌻 +- IDEA会自动将.properties文件的编码设置为ISO-8859-1,请在Settings > Editor > File Encodings > Properties Files > 设置为UTF-8 +- 请导入统一的代码格式化模板（Google）: Settings > Editor > Code Style > Java > 设置按钮 > import schema > 选择项目根目录下的GoogleStyle.xml文件 +- 如需要生成新的表，请使用CodeGenerator类进行生成。 + - 填入数据库地址，账号密码，库名。然后填入所需的表名执行代码即可。（大概看一下代码就知道怎么填啦） + - 生成的类在infrastructure模块下的target/classes目录下 + - 不同的数据库keywordsHandler方法请填入对应不同数据库handler。（搜索keywordsHandler关键字） +- 项目基础环境搭建，请参考docker目录下的指南搭建。保姆级启动说明： + - [AgileBoot - 手把手一步一步带你Run起全栈项目(SpringBoot+Vue3)](https://juejin.cn/post/7153812187834744845) +- 注意：管理后台的后端启动类是AgileBoot**Admin**Application +- Swagger的API地址为 http://localhost:8080/v3/api-docs + +## 🎬 AgileBoot全栈交流群 🎬 + +QQ群： [![加入QQ群](https://img.shields.io/badge/1398880-blue.svg)](https://qm.qq.com/cgi-bin/qm/qr?k=TR5guoXS0HssErVWefmdFRirJvfpEvp1&jump_from=webapi&authKey=VkWMmVhp/pNdWuRD8sqgM+Sv2+Vy2qCJQSeLmeXlLtfER2RJBi6zL56PdcRlCmTs) 点击按钮入群。 + + +如果觉得该项目对您有帮助，可以小额捐赠支持本项目演示网站服务器等费用~ + + + logo

+ +## 💕 特别鸣谢 + + +- @pokr 感谢提供ChatGpt账号助力本项目开发 + +## 💒 相关框架 +- 基于node.js开发的后端 Midwayjs diff --git a/backend/agileboot-admin/pom.xml b/backend/agileboot-admin/pom.xml new file mode 100644 index 0000000..d53826a --- /dev/null +++ b/backend/agileboot-admin/pom.xml @@ -0,0 +1,72 @@ + + + + agileboot + com.agileboot + 1.0.0 + + jar + 4.0.0 + + agileboot-admin + + + web服务入口 + + + + + + + com.agileboot + agileboot-domain + + + + org.springframework.boot + spring-boot-starter-test + test + + + org.junit.vintage + junit-vintage-engine + + + + + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + + org.springframework.boot + spring-boot-maven-plugin + + + + repackage + + + + + + org.apache.maven.plugins + maven-surefire-plugin + ${maven.surefire.plugin.version} + + + false + + + + + + + + diff --git a/backend/agileboot-admin/src/main/java/com/agileboot/admin/AgileBootAdminApplication.java b/backend/agileboot-admin/src/main/java/com/agileboot/admin/AgileBootAdminApplication.java new file mode 100644 index 0000000..7fdfd4c --- /dev/null +++ b/backend/agileboot-admin/src/main/java/com/agileboot/admin/AgileBootAdminApplication.java @@ -0,0 +1,32 @@ +package com.agileboot.admin; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration; +import org.springframework.context.annotation.ComponentScan; + +/** + * 启动程序 + * 定制banner.txt的网站 + * http://patorjk.com/software/taag + * http://www.network-science.de/ascii/ + * http://www.degraeve.com/img2txt.php + * http://life.chacuo.net/convertfont2char + * @author valarchie + */ +@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class}) +@ComponentScan(basePackages = "com.agileboot.*") +public class AgileBootAdminApplication { + + public static void main(String[] args) { + SpringApplication.run(AgileBootAdminApplication.class, args); + String successMsg = " ____ _ _ __ _ _ \n" + + " / ___| | |_ __ _ _ __ | |_ _ _ _ __ ___ _ _ ___ ___ ___ ___ ___ / _| _ _ | || |\n" + + " \\___ \\ | __|/ _` || '__|| __| | | | || '_ \\ / __|| | | | / __|/ __|/ _ \\/ __|/ __|| |_ | | | || || |\n" + + " ___) || |_| (_| || | | |_ | |_| || |_) | \\__ \\| |_| || (__| (__| __/\\__ \\\\__ \\| _|| |_| || ||_|\n" + + " |____/ \\__|\\__,_||_| \\__| \\__,_|| .__/ |___/ \\__,_| \\___|\\___|\\___||___/|___/|_| \\__,_||_|(_)\n" + + " |_| "; + + System.out.println(successMsg); + } +} diff --git a/backend/agileboot-admin/src/main/java/com/agileboot/admin/controller/common/FileController.java b/backend/agileboot-admin/src/main/java/com/agileboot/admin/controller/common/FileController.java new file mode 100644 index 0000000..7290371 --- /dev/null +++ b/backend/agileboot-admin/src/main/java/com/agileboot/admin/controller/common/FileController.java @@ -0,0 +1,129 @@ +package com.agileboot.admin.controller.common; + +import cn.hutool.core.collection.CollUtil; +import cn.hutool.core.io.FileUtil; +import cn.hutool.core.io.file.FileNameUtil; +import com.agileboot.common.constant.Constants.UploadSubDir; +import com.agileboot.common.core.dto.ResponseDTO; +import com.agileboot.common.exception.ApiException; +import com.agileboot.common.exception.error.ErrorCode; +import com.agileboot.common.exception.error.ErrorCode.Business; +import com.agileboot.common.utils.ServletHolderUtil; +import com.agileboot.common.utils.file.FileUploadUtils; +import com.agileboot.common.utils.jackson.JacksonUtil; +import com.agileboot.domain.common.dto.UploadDTO; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.tags.Tag; +import java.util.ArrayList; +import java.util.List; +import javax.servlet.http.HttpServletResponse; +import lombok.extern.slf4j.Slf4j; +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpStatus; +import org.springframework.http.MediaType; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RestController; +import org.springframework.web.multipart.MultipartFile; + +/** + * 通用请求处理 + * TODO 需要重构 + * @author valarchie + */ +@Tag(name = "上传API", description = "上传相关接口") +@RestController +@RequestMapping("/file") +@Slf4j +public class FileController { + + + /** + * 通用下载请求 + * download接口其实不是很有必要 + * @param fileName 文件名称 + */ + @Operation(summary = "下载文件") + @GetMapping("/download") + public ResponseEntity fileDownload(String fileName, HttpServletResponse response) { + try { + if (!FileUploadUtils.isAllowDownload(fileName)) { + // 返回类型是ResponseEntity 不能捕获异常，需要手动将错误填到 ResponseEntity + ResponseDTO