# mybatis-table-modify

**Repository Path**: ctllin/mybatis-table-modify

## Basic Information

- **Project Name**: mybatis-table-modify
- **Description**: 通过在Entity上添加注解来创建表和维护数据库表结构，支持了mybatis和mybatis plus，本项目是A.CTable项目的一个fork分支，感谢原作者的付出
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 13
- **Created**: 2023-05-29
- **Last Updated**: 2023-05-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Mybatis-Table-Modify(表结构管理工具)

<p>
 <img src='https://gitee.com/bootx/mybatis-table-modify/badge/star.svg?theme=dark' alt='star'/>
 <img src="https://img.shields.io/badge/mybatis table modify-1.5.3.alpha1-success.svg" alt="Build Status"/>
<img src="https://img.shields.io/badge/Author-Bootx-orange.svg" alt="Build Status"/>
 <img src="https://img.shields.io/badge/license-Apache%20License%202.0-green.svg"/>
</p>

## 🍈项目介绍
本项目Fork自 [A.C.Table](https://gitee.com/sunchenbin/mybatis-enhance)，之前在其他项目中用到了A.C.Table，
并对功能进行了改造。因为该A.C.Table项目近期发生了停更，所以打算把这些功能给开源出来，同时继续将这个项目完善下去。

## 🍎 路线图
- 1.5.2 主要目标：调整项目结构，去除除表维护相关的其他功能，代码暂时只适配Spring Boot项目
- 1.5.3 主要目标
  - [x] 拆分为Maven多模块项目，支持非Spring Boot的项目接入
  - [x] 支持MP的字段忽略配置
  - 支持简单索引方式（MySql）,与标准索引无法一起使用
  - [x] 新增追加模式，对一个表的属性只做新增和修改， 不做删除
  - [x] 空对象不进行创建
- 1.5.x 目标：
  - 支持SQL Server数据库的表维护
  - 支持Oracle数据库的表维护
  - 支持达梦数据库的表维护
  - 提供接入其他类型数据库的插件机制
- 1.6.x 目标：
  - 支持非Spring中间件的项目接入

## 使用说明
> 推荐只在开发时使用，生产环境停用自动更新

示例项目: [mybatis-table-modify-example](https://gitee.com/bootx/mybatis-table-modify-example)
### 添加pom依赖
```xml
    <dependency>
        <groupId>cn.bootx</groupId>
        <artifactId>mybatis-table-modify</artifactId>
        <version>${latest.version}</version>
    </dependency>
```
[最新版本](https://mvnrepository.com/artifact/cn.bootx/mybatis-table-modify)
### 配置要建表的路径
```yaml
mybatis-table:
  # 数据库类型
  database-type: mysql
  # 更新类型
  update-type: create
  # 扫描包路径, 可以用 ,和 ; 分隔
  scan-package: cn.bootx.**.entity
```
### 其他配置
> 无论是使用MyBatis还是MyBatis Plus，需要保证项目中的`mapper`被扫描到，否则会报错无法启动，
>
> 项目中`mapper`文件所在的路径为 `classpath*:cn/bootx/mybatis/table/modify/impl/*/mapper/*TableModifyMapper.xml`

#### MyBatis配置扫描
```yaml
mybatis:
  mapper-locations: classpath*:mapper/**/*Mapper.xml
```
#### MyBatis Plus配置扫描
```yaml
# mp配置
mybatis-plus:
  mapper-locations: classpath*:mapper/**/*Mapper.xml
```


## 🛠️核心注解
> 不同的数据库各自会有一些专属的注解，通常适用于对应类型数据库专有的配置，如MySQL专有的`MySqlEngine(存储引擎)`、`MySqlFieldType(字段类型)`等
### @DbTable
> 表注释，标注在要进行建表的实体类上

| 属性            | 类型           | 默认值     | 描述                                                   |
|---------------|--------------|---------|------------------------------------------------------|
| name          | String       | ""      | 表名，未配置时会读取`TableName`中的配置                            |
| value         | String       | ""      | 表名，未配置时会读取`TableName`中的配置                            |
| comment       | String       | ""      | 表注释                                                  |
| charset       | MySqlCharset | "" | 数据库默认字符集                                             |
| isSimple      | boolean      | true    | 是否开启`simple`模式配置，开启后字段不写注解`@Column`也可以采用默认的驼峰转换法创建字段 |
| excludeFields | String[]     | {}      | 需要排除的属性名，排除掉的属性不参与建表, 静态字段默认会被排除                     |

### @Column
> 字段注解，`@DbTable`开启`simple`模式后，`@DbColumn`不标注也会根据规则进行转换

| 属性              | 类型             | 默认值       | 描述                                         |
|-----------------|----------------|-----------|--------------------------------------------|
| name            | String         | ""        | 行名，未配置时会读取`Column`中的配置                     |
| value           | String         | ""        | 行名，未配置时会读取`Column`中的配置                     |
| order           | int            | 0         | 数据库字段排序，数字小的在前面，大的在后面                      |
| type            | MySqlFieldType | DEFAULT   | 不填默认使用属性的数据类型进行转换，转换失败的字段不会添加              |
| length          | int            | 255       | 字段长度，默认是255                                |
| decimalLength   | int            | 0         | 小数点长度，默认是0                                 |
| isNull          | boolean        | true      | 是否为可以为null，`true`是可以，`false`是不可以，默认为`true` |
| isKey           | boolean        | false     | 是否是主键，默认`false`                            |
| isAutoIncrement | boolean        | false     | 是否自动递增，默认`false`，只有主键才能使用                  |
| defaultValue    | String         | "DEFAULT" | 默认值，默认为null                                |
| comment         | String         | ""        | 数据表字段备注                                    |
| ignore          | boolean        | false     | 是否排除该字段, 默认不排除                             |

##  🥂 Bootx 项目合集
- Bootx-Platform：单体版脚手架 [Gitee地址](https://gitee.com/bootx/bootx-platform)
- Bootx-Cloud：微服务版脚手架 [Gitee地址](https://gitee.com/bootx/bootx-cloud)
- dax-pay：开源支付系统 [Gitee地址](https://gitee.com/bootx/dax-pay)
- bpm-plus：协同办公系统 [Gitee地址](https://gitee.com/bootx/bpm-plus)
- mybatis-table-modify：数据表结构管理 [Gitee地址](https://gitee.com/bootx/mybatis-table-modify)

##  🥪 关于我们

QQ扫码加入QQ交流群
<p>

<img src="https://oscimg.oschina.net/oscnet/up-ac1a8f8221203de2b5cbc6a461a26199b95.jpg" width = "330" height = "500"/>
</p>

## 🍻 鸣谢
感谢 JetBrains 提供的免费开源 License：

[![JetBrains](https://oscimg.oschina.net/oscnet/up-4aab9fa8bc769295b48c888d93e71320d93.png)](https://www.jetbrains.com/?from=bootx)

## 🍷License

Apache License Version 2.0