# SpringBoot项目模板

**Repository Path**: cao-anjiang/springboot-template

## Basic Information

- **Project Name**: SpringBoot项目模板
- **Description**: 设计一个springboot初始化模板，方便项目的二次开发
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 6
- **Forks**: 1
- **Created**: 2023-10-19
- **Last Updated**: 2026-03-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SpringBoot初始化项目模板
<!-- TOC -->
* [SpringBoot初始化项目模板](#springboot初始化项目模板)
    * [介绍](#介绍)
    * [软件架构](#软件架构)
    * [安装教程](#安装教程)
    * [初始化操作](#初始化操作)
    * [git管理](#git管理)
    * [参与贡献](#参与贡献)
<!-- TOC -->

## 介绍
初始化一个SpringBoot项目模板，新创建一个项目，可以直接在此基础上进行开发

## 软件架构
springboot框架 java8 maven项目 pg12.16（或mysql 5.7.35）
持久层框架mybatis-plus 3.5.10

## 安装教程
> git clone https://gitee.com/cao-anjiang/springboot-template.git


## 初始化操作
1. 首先直接修改项目的名称（更改文件夹的名字）
2. 进入项目，配好你本地的maven信息
3. 修改pom.xml中关于项目的信息（修改完需要reload maven）
4. 可以修改这个readme.md文件，用来介绍自己的项目
5. 还可以rename项目名，直接修改即可（MyTemplateApplication）

## 项目操作
1. 修改[application-dev.yml](src%2Fmain%2Fresources%2Fapplication-dev.yml)中关于数据库相关的配置
2. 将数据库建到自己的设备中，sql文件为[tbl_log_pg.sql](db%2Ftbl_log_pg.sql),当然如果你想用mysql，那就是[tbl_log_mysql.sql](db%2Ftbl_log_mysql.sql)
3. 可以访问下面地址查看接口: http://localhost:18080/swagger-ui.html

## git管理
克隆项目后，如果想加入git管理，我们要先删除掉之前的提交，再做初始化。
步骤有三步：

1. 先将文件夹原来的 **.git**文件夹删除掉 （这个文件夹默认情况下是隐藏的，如果你看不到这个文件夹，则需要去设置一下显示隐藏文件夹）
2. 项目进行git初始化


> git init # 初始化项目, 这句命令会新建一个.git文件夹

> git add . # 将修改添加到暂存

> git commit -m "项目初始化" # 将暂存提到本地仓库


如果想将项目放到自己的git仓库中：
1. 在gitee上创建一个与本地同名的、 空的 、公开的远程仓库。

2. 建立关联：
> git remote add origin <远程仓库地址>  #添加远程仓库地址

3. 推送master分支到远程仓库：
> git push -u origin master

## 后续删除
项目中的test和log模块只是一个模板，后续参照此方式进行新建其他模块后可以删除掉：
1. controller中：[LogController.java](src%2Fmain%2Fjava%2Fcaj%2Fspringboot%2Fcontroller%2FLogController.java)，[TestController.java](src%2Fmain%2Fjava%2Fcaj%2Fspringboot%2Fcontroller%2FTestController.java)
2. mapper中：[LogMapper.java](src%2Fmain%2Fjava%2Fcaj%2Fspringboot%2Fmapper%2FLogMapper.java)
3. model中：Log和Test开头的所有类和接口（比较多就不一一罗列了）
4. sevice中：[LogService.java](src%2Fmain%2Fjava%2Fcaj%2Fspringboot%2Fservice%2FLogService.java)，[LogServiceImpl.java](src%2Fmain%2Fjava%2Fcaj%2Fspringboot%2Fservice%2Fimpl%2FLogServiceImpl.java)
5. resources中：[LogMapper.xml](src%2Fmain%2Fresources%2Fmapper%2FLogMapper.xml)

## pg数据库或mysql数据库的互转
如果要将mysql转成pg数据库，可以将对应的地方修改一下，这里我们使用pg的版本是12.16（同理pg转mysql也是相同的道理）
1. 首先到pom.xml文件中加上pg的驱动
2. 再去application.yml中修改数据库驱动程序的类名
3. 再去application-dev.yml中修改数据库连接
4. 数据库表在[tbl_log_pg.sql](db%2Ftbl_log_pg.sql)
5. 注意使用pg数据库时需要在navicate设置主键自增，否则插入数据时会有问题，具体可以参考我的一篇文章：[navicat在pg数据库中设置自增](https://blog.csdn.net/Freedom_cao/article/details/144702009?sharetype=blogdetail&sharerId=144702009&sharerefer=PC&sharesource=Freedom_cao&spm=1011.2480.3001.8118)

## 代码生成器的使用
本项目使用mybatis-plus中的新版的代码生成器（3.5.10），并将生成模板进行改装，变成适用于本项目的代码生成器，如果pg和mysql互转的话，只需要修改其中的数据库连接即可

使用方式:直接运行CodeGenerator中的main函数即可，不过需要有对应的数据表，修改对应的表名即可：[CodeGenerator.java](src%2Fmain%2Fjava%2Fcaj%2Fspringboot%2FCodeGenerator.java)

## 参与贡献
曹安江