浅谈springboot中tk.mapper代码生成器的用法说明

浅谈Spring Boot中 tk.mapper 代码生成器的用法说明

介绍

Spring Boot 是一个十分流行的 Java Web 开发框架，它简化了很多传统 java web 开发的繁琐步骤，让开发人员快速构建高效的 Web 应用。如果你使用 Spring Boot 作为你的项目框架，那么你可能需要使用 tk.mapper 代码生成器来生成 MyBatis 的 Mapper 接口和对应的 XML 文件。

tk.mapper 代码生成器

tk.mapper 是 MyBatis 和 Spring Boot 中比较流行的持久层框架之一，它提供了一个简单易用的方式来生成 MyBatis 的 Mapper 以及对应的 XML 文件。使用 tk.mapper 开发，你可以更集中地关注于业务逻辑，快速开发运维高效的 Java Web 应用。

使用 tk.mapper 的过程

使用 tk.mapper 可以跟随以下步骤进行：

1. 添加 Maven 依赖：

```xml

tk.mybatis
mapper
4.2.0

```

1. 添加代码生成器配置文件：

yaml
mapper:
mappers-package: tk.mybatis.mapper.common.base
not-empty: false
identity: MYSQL
style: normal

1. 使用 tk.mapper 代码生成器生成 Mapper 以及 XML 文件。

配置文件说明

配置项	描述
mappers-package	指定 Mapper 的接口所在包，默认为 tk.mybatis.mapper.common.base
not-empty	是否自动在 SQL 模版中增加 where 条件，支持 true 或 false，默认为 false
identity	主键策略，默认为 UUID，同时支持AUTO、SEQUENCE、IDENTITY、NONE
style	生成代码的风格（样式），normal（默认）、camelhump、uppercase、lowercase

示例

假设我们有一个表 t_user，它有以下字段：

字段名	类型	说明
id	int	自增主键
name	varchar(8)	名称
age	int	年龄
address	varchar(8)	地址

我们可以按照如下方式使用 tk.mapper 来生成对应的 Mapper 接口以及 XML 文件。

1. 添加表和映射的实体类

java
@Table(name = "t_user")
public class User {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Integer id;
private String name;
private Integer age;
private String address;
//getter 和 setter 略
}

1. 使用 tk.mapper 代码生成器来生成 Mapper

java
@Mapper
public interface UserMapper extends tk.mybatis.mapper.common.Mapper<User> {
}

1. 生成完成后 tk.mapper 将自动在 src/main/resources/mapper 目录下生成 UserMapper.xml

2. 使用该 Mapper 增删改查。

```java
@RestController
@RequestMapping("/user")
public class UserController {
@Autowired
private UserMapper userMapper;

   @GetMapping("/{id}")
   public User findById(@PathVariable Integer id) {
       return userMapper.selectByPrimaryKey(id);
   }

   @PostMapping("")
   public void insert(@RequestBody User user) {
       userMapper.insertSelective(user);
   }

}
```

总结

使用 tk.mapper 可以快速生成 MyBatis 的 Mapper 接口以及 XML 文件，使得 Java Web 应用的开发更加快捷高效。上述步骤和示例可以帮助你快速了解 tk.mapper 的基本用法。