拥抱新姿势：Springboot开启Mybatis驼峰命名自动映射的指引

2023-07-28 03:17:04

开启 Springboot Mybatis 驼峰命名自动映射的进阶指南

背景

作为程序员，我们经常处理各种数据，而数据持久化是其中至关重要的环节。Mybatis 作为一款优秀的 ORM 框架，提供了强大的功能和灵活性，受到了广泛的青睐。然而，开发中经常会遇到一个问题：数据库字段名和 Java 对象属性名不一致。

为了解决这一问题，Mybatis 提供了驼峰命名自动映射功能，可以让数据库字段名自动映射到 Java 对象属性名。Springboot 作为轻量级的框架，提供了多种开启驼峰命名自动映射的方式。本文将深入探讨这几种方式，帮助你根据需求选择最合适的方法。

方式一：配置文件开启

这是最简便的方式，只需在配置文件中添加以下配置即可：

mybatis:
  configuration:
    map-underscore-to-camel-case: true

方式二：代码中开启

如果你不想修改配置文件，也可以在代码中开启驼峰命名自动映射功能。代码设置如下：

@Configuration
public class MybatisConfig {

    @Bean
    public SqlSessionFactory sqlSessionFactory() throws Exception {
        SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
        factoryBean.setDataSource(dataSource());
        factoryBean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper/*.xml"));
        factoryBean.getConfiguration().setMapUnderscoreToCamelCase(true);
        return factoryBean.getObject();
    }
}

方式三：注解开启

如果你只想对某个特定的 Mapper 开启驼峰命名自动映射功能，可以使用以下注解：

@Mapper
@MapUnderscoreToCamelCase
public interface UserMapper {

    @Select("SELECT * FROM user")
    List<User> findAll();
}

代码示例

以下代码演示了开启驼峰命名自动映射功能后的效果：

数据库表结构：

CREATE TABLE user (
  id INT NOT NULL AUTO_INCREMENT,
  user_name VARCHAR(255) NOT NULL,
  email VARCHAR(255) NOT NULL,
  PRIMARY KEY (id)
);

Java 对象属性：

public class User {
  private Integer id;
  private String userName;
  private String email;
  //省略 getters 和 setters
}

Mybatis Mapper：

<select id="findAll" resultMap="userResultMap">
  SELECT * FROM user
</select>

<resultMap id="userResultMap" type="User">
  <result property="id" column="id" />
  <result property="userName" column="user_name" />
  <result property="email" column="email" />
</resultMap>

结果：

开启驼峰命名自动映射功能后，Mybatis 会自动将数据库字段名映射到 Java 对象属性名，返回结果如下：

List<User> users = userMapper.findAll();
for (User user : users) {
  System.out.println(user.getId());
  System.out.println(user.getUserName());
  System.out.println(user.getEmail());
}