# site-bale

**Repository Path**: chichengyu/site-bale

## Basic Information

- **Project Name**: site-bale
- **Description**: 单体应用整合脚手架，便于快捷开发
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2020-06-28
- **Last Updated**: 2025-11-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# site-bale

#### 介绍
<!-- 生成网址：https://shields.io/ -->
<p align="center">
    <a href="https://gitee.com/chichengyu/springBoot-shiro-vue-element-admin">
        <img src="https://img.shields.io/badge/%E4%BD%9C%E8%80%85-%E5%B0%8F%E6%B1%A0-brightgreen" alt="MIT License" />
    </a>
    <a href="https://gitee.com/chichengyu/springBoot-shiro-vue-element-admin">
        <img src="https://img.shields.io/badge/qq-875267425-ff69b4" alt="Vue2.0">
    </a>
</p>
用于快速开发RESTful单项目，整合了 Spring Boot、MyBatis Plus、Redis、Redisson、Quartz，配置`Async`异步线程池以及提供6个注解： `@AccessLimit`(接口限流注解）、`@ParamXssPass` (过滤参数防止xss攻击注解 ）、`@CurrentUser `(获取当前登录用户注解)、`@Excel`(Excel导出导入注解)、`@Log`(记录操作日志注解)、`@Auth`(Auth登录权限控制注解)

 - 后台模板可以使用 [vue-element-admin](https://gitee.com/chichengyu/vue-element-admin)，这是自己搭建的一个webpack脚手架，下载即用

#### 技术选型
  - 核心框架：Spring Boot 2.2.6
  - 持久层：MyBatis Plus(通用mapper 2.1.5)
  - 连接池：Druid 1.1
  - 任务调度：Quartz 2.3.2
  - 日志管理：SLF4J 1.7.30、logback1.2.3
  - Swagger文档 2.9
  - Redis
  - Redisson

#### 软件需求

  - JDK1.8
  - MySQL5.6+
  - Maven3.0+
  - Redis3.0+

#### 本地部署

  - 通过git下载源码
  - idea、eclipse需安装lombok插件，不然会提示找不到entity的get set方法
  - 创建数据库 ` bale `，数据库编码为UTF-8
  - 执行 ` db/quartz.sql `文件，初始化数据【按需导入表结构】,`sql` 文件只包含定时器 `Quartz`表与自定义的2张定时器表
  - 修改 ` application-dev.yml`文件，更新 `MySQL`账号和密码
  - 在 ` bale ` 目录下，执行 ` mvn clean install `，跳过单元测试 `mvn clean install -DskipTests` 或者 `mvn clean install -Dmaven.test.skip=true`
  - IDEA运行 `Application.java`，则可启动项目【bale】,需要启动 `Redis`
  - 项目打包：根目录运行
    - 开发环境：`mvn clean package`
    - 生产环境：`mvn clean package -D runenv=prod`

  - 说明：
    - Druid监控：`http://localhost:8080/bale/druid`，账号: `admin`，密码:`1234`
    - Swagger文档：`http://localhost:8080/bale/swagger-ui.html`
    
#### shell脚本部署
请看文档：https://gitee.com/chichengyu/site-bale/tree/master/bale/sh

#### docker部署

  - 通过git下载源码
  - idea、eclipse需安装lombok插件，不然会提示找不到entity的get set方法
  - maven切换配置文件为 ` prod`,打包，或者 `mvn clean package -D runenv=prod`
  - 打包后，通过`xshell` 连接服务器 连接服务器，创建目录 `bale`,并将根目录下 `target/bale.jar` 及 `docker` 目录下的所有文件全部上传到创建的 `bale`目录下
  - 安装容器 `docker` 与 `docker-compose`
    - 安装docker：`yum install -y docker`
    - `docker-compose` 根据[官网文档](https://docs.docker.com/compose/install/)进行安装
  - 在 `bale` 目录下执行 ` docker-run.sh `文件，`sh docker-run.sh`进行一键部署
    - 通过 `docker-compose logs` 可查询日志
    - 如果项目显示连接不上 `mysql` 服务，请另外建一个目录把所有文件及目录拷贝过去，然后去到另外目录执行 `sh docker-run.sh` 进行部署，原因可能是因为docker有缓存，可尝试清除缓存：`docker system prune -a`
    - 部署结束后，可根据提示的账户密码在工具中进行远程客户端连接
 

  - 说明：
    - Druid监控：`http://xxxx:8080/bale/druid`，账号: `admin`，密码:`1234`
    - Swagger文档：`http://xxxx:8080/bale/swagger-ui.html`

  - 注意：拉取项目后，在windows系统下,一定要用 `notepad++` 编辑 `docker-run.sh` 文件，双击文件右下角编码区域选择"转换为UNIX格式"，否则执行会报错
  - logback日志追踪[traceid.md](https://gitee.com/chichengyu/site-bale/blob/master/traceid.md)