# mybatis-plus-generator

**Repository Path**: OpenBodhi/mybatis-plus-generator

## Basic Information

- **Project Name**: mybatis-plus-generator
- **Description**: mybatis-plus-generator代码生成器
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-10
- **Last Updated**: 2026-05-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 💡 项目简介

基于 Spring Boot 4.x & MyBatis-Plus 的代码生成器，自定义controller模板，生成entity、mapper、mapper xml、service、service impl、controller等文件，可快速生成Restful API项目。如有需要可自定义其他产物。

## 🛠️ 核心技术栈

本项目严格遵循现代化 Java 开发标准：

| 组件 | 版本/说明     | 用途 |
| :--- |:----------| :--- |
| **Spring Boot** | `4.0+`    | 核心框架 |
| **MyBatis-Plus** | `3.5.16+` | 增强版 ORM 框架，提供强大的 CRUD 能力 |
| **Dynamic Datasource** | `4.0+`    | 强大的多数据源解决方案，支持读写分离 |
| **SpringDoc** | `3.0+`    | OpenAPI 3 接口文档生成器 (替代 Swagger) |
| **Lombok** | -         | 简化 Java Bean 冗余代码 |
| **HikariCP** | 默认        | Spring Boot 4 内置高性能连接池 |
| **Velocity** | `2.4+`    | 代码生成器模板引擎 |


## 📦 环境要求

- **JDK:** 17 或以上 (推荐 25)
- **Maven:** 3.6.3+
- **MySQL:** 8.0+
- **IDE:** IntelliJ IDEA (推荐)


## 🚀 快速开始

### 1. 克隆项目
```bash
git clone https://gitee.com/OpenBodhi/mybatis-plus-generator.git
```

### 2. 创建数据库表
> sql文件位于sql/db.sql
> 

创建数据库db_test，字符集为utf8mb4，排序字符集为utf8mb4_0900_ai_ci，执行sql文件。

### 3. 生成代码

> 配置信息参考**CodeGenerator.java**的基础配置变量区域，根据自身需要配置。

打开CodeGenerator.java，配置数据库连接信息，执行 CodeGenerator程序生成代码

```java
    // 数据库连接信息
    private static final String DB_URL = "jdbc:mysql://localhost:3306/db_test?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai&useSSL=false";
    private static final String DB_USERNAME = "root";
    private static final String DB_PASSWORD = "123456";
```

### 4. 测试

打开application.yaml，配置数据库连接信息，执行DemoApplication运行。

```yaml
          url: jdbc:mysql://localhost:3306/db_test?useSSL=false&useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
          username: root
          password: 123456
```

项目启动后，可通过以下地址查看自动生成的 API 文档：

👉 Swagger UI: http://localhost:8080/swagger-ui.html






## 🗂️ 项目结构

```md
demo/
├── sql/
│   └── db.sql  // 测试SQL文件
├── src/
│   ├── main/
│   │   ├── java/
│   │   │     └── com.example.demo/
│   │   │               ├── common/
│   │   │               │   └── r/
│   │   │               │       ├── R.java  // 统一响应结果
│   │   │               │       └── RCode.java  // 响应结果枚举类 
│   │   │               ├── config/
│   │   │               │   └── MybatisPlusConfig.java // MyBatis-Plus配置，如分页配置
│   │   │               ├── CodeGenerator.java   // MyBatis-Plus 代码生成器入口
│   │   │               └── DemoApplication.java // Spring Boot 启动类
│   │   └── resources/
│   │       ├── templates/
│   │       │   └── controller.java.vm  // controller模板
│   │       └── application.yaml
│   └── test/
└── pom.xml
```



## 📦产物效果展示

### entity

User.java

```java
package com.example.demo.entity;

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableLogic;
import com.baomidou.mybatisplus.annotation.TableName;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;

import java.io.Serial;
import java.io.Serializable;
import java.math.BigDecimal;
import java.time.LocalDate;
import java.time.LocalDateTime;

/**
 * <p>
 * 
 * </p>
 *
 * @author YourName
 * @since 2026-05-10
 */
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
@TableName("tb_user")
@Accessors(chain = true)
@Schema(name = "User", description = "")
public class User implements Serializable {

    @Serial
    private static final long serialVersionUID = 1L;

    /**
     * 主键ID
     */
    @Schema(description = "主键ID")
    @TableId(value = "id", type = IdType.AUTO)
    private Long id;

    /**
     * 用户名
     */
    @TableField("username")
    @Schema(description = "用户名")
    private String username;

    /**
     * 年龄
     */
    @TableField("age")
    @Schema(description = "年龄")
    private Integer age;

    /**
     * 性别 (0-未知 1-男 2-女)
     */
    @TableField("gender")
    @Schema(description = "性别 (0-未知 1-男 2-女)")
    private Integer gender;

    /**
     * 余额 (DECIMAL类型测试)
     */
    @TableField("balance")
    @Schema(description = "余额 (DECIMAL类型测试)")
    private BigDecimal balance;

    /**
     * 体重 (FLOAT类型测试)
     */
    @TableField("weight_float")
    @Schema(description = "体重 (FLOAT类型测试)")
    private Double weightFloat;

    /**
     * 身高 (DOUBLE类型测试)
     */
    @TableField("height_double")
    @Schema(description = "身高 (DOUBLE类型测试)")
    private Double heightDouble;

    /**
     * 纬度 (科学计算/坐标)
     */
    @TableField("latitude")
    @Schema(description = "纬度 (科学计算/坐标)")
    private Double latitude;

    /**
     * 头像URL
     */
    @TableField("avatar")
    @Schema(description = "头像URL")
    private String avatar;

    /**
     * 邮箱
     */
    @TableField("email")
    @Schema(description = "邮箱")
    private String email;

    /**
     * 手机号
     */
    @TableField("phone")
    @Schema(description = "手机号")
    private String phone;

    /**
     * 生日
     */
    @TableField("birthday")
    @Schema(description = "生日")
    private LocalDate birthday;

    /**
     * 最后登录时间
     */
    @TableField("login_time")
    @Schema(description = "最后登录时间")
    private LocalDateTime loginTime;

    /**
     * 个人简介
     */
    @TableField("bio")
    @Schema(description = "个人简介")
    private String bio;

    /**
     * 扩展信息(JSON)
     */
    @TableField("extra_info")
    @Schema(description = "扩展信息(JSON)")
    private String extraInfo;

    /**
     * 乐观锁版本号
     */
    @TableField("version")
    @Schema(description = "乐观锁版本号")
    private Integer version;

    /**
     * 备注
     */
    @TableField("remark")
    @Schema(description = "备注")
    private String remark;

    /**
     * 排序
     */
    @TableField("sort")
    @Schema(description = "排序")
    private Integer sort;

    /**
     * 角色状态(1-正常 0-禁用)
     */
    @TableField("status")
    @Schema(description = "角色状态(1-正常 0-禁用)")
    private Integer status;

    /**
     * 创建者ID
     */
    @TableField("create_by")
    @Schema(description = "创建者ID")
    private Long createBy;

    /**
     * 创建时间
     */
    @Schema(description = "创建时间")
    @TableField(value = "create_time", fill = FieldFill.INSERT)
    private LocalDateTime createTime;

    /**
     * 更新者ID
     */
    @TableField("update_by")
    @Schema(description = "更新者ID")
    private Long updateBy;

    /**
     * 更新时间
     */
    @Schema(description = "更新时间")
    @TableField(value = "update_time", fill = FieldFill.INSERT_UPDATE)
    private LocalDateTime updateTime;

    /**
     * 逻辑删除标识(1-已删除 0-未删除)
     */
    @TableLogic
    @TableField("is_deleted")
    @Schema(description = "逻辑删除标识(1-已删除 0-未删除)")
    private Integer isDeleted;
}

```

### mapper

UserMapper.java

```java
package com.example.demo.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.example.demo.entity.User;
import org.apache.ibatis.annotations.Mapper;

/**
 * <p>
 *  Mapper 接口
 * </p>
 *
 * @author YourName
 * @since 2026-05-10
 */
@Mapper
public interface UserMapper extends BaseMapper<User> {

}

```

### mapper xml

UserMapper.xml

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.example.demo.mapper.UserMapper">

    <!-- 通用查询映射结果 -->
    <resultMap id="BaseResultMap" type="com.example.demo.entity.User">
        <id column="id" property="id" />
        <r column="username" property="username" />
        <r column="age" property="age" />
        <r column="gender" property="gender" />
        <r column="balance" property="balance" />
        <r column="weight_float" property="weightFloat" />
        <r column="height_double" property="heightDouble" />
        <r column="latitude" property="latitude" />
        <r column="avatar" property="avatar" />
        <r column="email" property="email" />
        <r column="phone" property="phone" />
        <r column="birthday" property="birthday" />
        <r column="login_time" property="loginTime" />
        <r column="bio" property="bio" />
        <r column="extra_info" property="extraInfo" />
        <r column="version" property="version" />
        <r column="remark" property="remark" />
        <r column="sort" property="sort" />
        <r column="status" property="status" />
        <r column="create_by" property="createBy" />
        <r column="create_time" property="createTime" />
        <r column="update_by" property="updateBy" />
        <r column="update_time" property="updateTime" />
        <r column="is_deleted" property="isDeleted" />
    </resultMap>

    <!-- 通用查询结果列 -->
    <sql id="Base_Column_List">
        id, username, age, gender, balance, weight_float, height_double, latitude, avatar, email, phone, birthday, login_time, bio, extra_info, version, remark, sort, status, create_by, create_time, update_by, update_time, is_deleted
    </sql>

</mapper>

```

### service

IUserService.java

```java
package com.example.demo.service;

import com.example.demo.entity.User;
import com.baomidou.mybatisplus.extension.service.IService;

/**
 * <p>
 *  服务类
 * </p>
 *
 * @author YourName
 * @since 2026-05-10
 */
public interface IUserService extends IService<User> {

}

```

UserServiceImpl.java

```java
package com.example.demo.service.impl;

import com.example.demo.entity.User;
import com.example.demo.mapper.UserMapper;
import com.example.demo.service.IUserService;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.stereotype.Service;

/**
 * <p>
 *  服务实现类
 * </p>
 *
 * @author YourName
 * @since 2026-05-10
 */
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements IUserService {

}

```

### controller

```java
package com.example.demo.controller;

import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.example.demo.common.result.R;
import com.example.demo.common.result.Result;
import com.example.demo.entity.User;
import com.example.demo.service.IUserService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*;

import java.util.List;

/**
 * <p>
 * 测试用户 前端控制器
 * </p>
 *
 * @author YourName
 * @since 2026-05-10
 */
@RestController
@RequiredArgsConstructor
@RequestMapping("/api/v1/users")
@Tag(name = "测试用户管理", description = "包含测试用户增删改查及分页查询接口")
public class UserController {

    private final IUserService userService;

    @PostMapping
    @Operation(summary = "新增测试用户", description = "新增测试用户")
    public R<Void> save(@RequestBody @Parameter(description = "测试用户") User entity) {
        return R.success(userService.save(entity));
    }

    @DeleteMapping("/{id}")
    @Operation(summary = "根据id删除测试用户", description = "根据id删除测试用户")
    public R<Void> removeById(@PathVariable @Parameter(description = "测试用户id", required = true) Long id) {
        return R.success(userService.removeById(id));
    }

    @PutMapping
    @Operation(summary = "更新测试用户", description = "更新测试用户")
    public R<Void> updateById(@RequestBody @Parameter(description = "测试用户") User entity) {
        return R.success(userService.updateById(entity));
    }

    @GetMapping("/{id}")
    @Operation(summary = "根据id查询测试用户详情", description = "根据id查询测试用户详情")
    public R<User> getById(@PathVariable @Parameter(description = "测试用户id", required = true) Long id) {
        return R.success(userService.getById(id));
    }

    @GetMapping
    @Operation(summary = "查询所有测试用户", description = "查询所有测试用户")
    public R<List<User>> list() {
        return R.success(userService.list());
    }

    @GetMapping("/page")
    @Operation(summary = "分页查询测试用户", description = "根据页码和每页条数获取测试用户列表，支持传入查询条件")
    public R<IPage<User>> page(
            @Parameter(description = "当前页码", example = "1")
            @RequestParam(defaultValue = "1") Integer pageNum,
            @Parameter(description = "每页显示条数", example = "10")
            @RequestParam(defaultValue = "10") Integer pageSize
            //@Parameter(description = "用户名（支持模糊查询）", example = "aa")
            //@RequestParam(required = false) String username,
            //@Parameter(description = "用户状态（1-正常 0-禁用）", example = "1")
            //@RequestParam(required = false) Integer status
    ) {
        Page<User> page = new Page<>(pageNum, pageSize);
        page.setMaxLimit(100L);
        return R.success(userService.page(page));

        //// 创建分页对象
        //Page<User> page = new Page<>(pageNum, pageSize);
        //// 限制每页最多只能查 100 条
        //page.setMaxLimit(100L);
        //// 构建动态查询条件
        //LambdaQueryWrapper<User> wrapper = new LambdaQueryWrapper<>();
        //wrapper.like(StringUtils.hasText(username), User::getUsername, username)
        //        .eq(status != null, User::getStatus, status)
        //        .orderByDesc(User::getCreateTime);
        //// 执行分页查询并返回
        //return R.success(userService.page(page, wrapper));
    }
}
```

### 接口文档

![image](image.png)



## 📄 开源协议

本项目采用 MIT 开源协议。