# spring-boot-starter-jpa-comment

**Repository Path**: hlhutu/spring-boot-starter-jpa-comment

## Basic Information

- **Project Name**: spring-boot-starter-jpa-comment
- **Description**: 为jpa生成注释，支持SpringBoot3。
读取swagger注解即可生成注释，代码改动小，支持所有方言。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-01-04
- **Last Updated**: 2024-03-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# spring-boot-stater-jpa-comment

### 介绍

为jpa生成注释，基于swagger注解，简单易用。

**😁简单**

代码极少，只有2个类。

**⚡快速**

自动读取swagger注解，如果你本来就用了swagger，几乎不需要改代码。

**🐳兼容**

基于Hibernate方言识别，兼容所有Hibernate支持的数据库方言。

**🍃支持**

支持SpringBoot2.x + java1.8、SpringBoot3.x + java17。

### 快速开始

#### 导入

```xml
<dependency>
    <groupId>com.tomdog</groupId>
    <artifactId>spring-boot-starter-jpa-comment</artifactId>
    <version>1.1</version>
</dependency>
```

> 版本 1.0 -> Spring Boot 2.x  
> 版本 1.1 -> Spring Boot 3.x

#### 注解

```java
@Data
@Entity
@ApiModel(description = "测试用户")
public class DemoUser {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @ApiModelProperty("主键")
    private Long id;

    @ApiModelProperty("用户名")
    private String userName;

    @ApiModelProperty("布尔值")
    private Boolean bool;

    @ApiModelProperty("创建日期")
    private LocalDate createDate;
}
```

#### 重启

![img.png](img.png)

数据库注释已生成

![img_1.png](img_1.png)

❗注意必须重新建表才可使注释生效。