【Spring Boot】使用MyBatis注解实现数据库操作

使用MyBatis注解实现数据库操作

MyBatis还提供了注解的方式，相比XML的方式，注解的方式更加简单方便，无须创建XML配置文件。接下来好好研究注解的使用方式。

1.XML和注解的异同

1）注解模式使用简单，开发效率高，但是维护麻烦，修改SQL需要重新编译打包。

2）XML模式便于维护，SQL和代码分开，代码清晰易懂，而使用注解模式需要在方法前加各种注解和SQL语句，使得代码的可读性不强。

3）XML模式虽然提供了完善的标签来实现复杂的SQL语句，但是没有在Java代码中直接判断拼接那样简单方便。

4）XML模式因为SQL是配置在XML文件中的，某些特殊字符需要转义，所以使用起来比较麻烦，容易出错。

2.使用MyBatis注解实现数据查询

MyBatis注解模式的最大特点是取消了Mapper的XML配置，通过@Insert、、@Update、@Select、@Delete等注解将SQL语句定义在Mapper接口方法中或SQLProvider的方法中，从而省去了XML配置文件。这些注解和参数的使用与mapper.xml配置文件基本一致。下面就来演示使用MyBatis注解实现数据查询。

2.1 修改配置文件

首先创建Spring Boot项目，集成MyBatis的过程与XML配置方式一样。

使用注解方式只需要在application.properties中指明实体类的包路径，其他保持不变，配置示例如下：

#mapper.xml mapper接口的包路径
MyBatis.type-aliases-package=com.example.ysxq

#数据库连接
spring.datasource.url=jdbc:mysql://Localhost:3306/ceshi?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8&useSSL=true
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

在上面的示例中，配置了mapper接口的包路径和数据源，无须配置mapper.xml文件的路径。

2.2 添加mapper接口

使用MyBatis提供的SQL语句注解无须再创建mapper.xml映射文件，创建mapper接口类，然后添加相关的方法即可：

public interface StudentMapper {
    @Select("select * from student")
    List<Student> selectAll();
}

在上面的示例中，使用@Select注解定义SQL查询语句即可实现查询所有学生列表的功能，无须再定义mapper.xml映射文件。

2.3 验证测试

增加单元测试方法，验证是否生效。示例代码如下：

@Test
    public void testSelectAll() {
        // 查询
        List<Student> students = studentMapper.selectAll();
        for (Student stu : students) {
            System.out.println("name:"+stu.getName()+", age:"+stu.getAge());
        }
    }

单击Run Test或在方法上右击，选择Run ‘testSelectAll’，查看单元测试结果，运行结果如图所示。

结果表明单元测试方法testSelectAll运行成功，并输出了相应的查询结果。这说明使用注解成功实现了查询全部学生信息的功能。

3.参数传递

相信很多人会有疑问：MyBatis是如何将参数传递到SQL中的，有哪几种传参方式？下面就来一一介绍MyBatis注解的传参方式。

3.1 直接传参

对于简单的参数，可以直接使用#{id}的方式接收同名的变量参数。示例代码如下：

@Select("SELECT * FROM student where id=#{id,jdbcType=VARCHAR}")
Student selectOne(Long id);

在上面的示例中，使用#{id}传入变量参数，支持传入多个参数。只是需要注意，使用#{}方式定义的参数名必须和方法中的参数名保持一致。

3.2 使用@Param注解

@Param注解的作用是给参数命名，参数命名后就能根据名字匹配到参数值，正确地将参数传入SQL语句中。比如，注解是@Param(“person”)，那么参数就会被命名为#{person}。示例代码如下：

@Select("select * from student where name=#{name} and sex=#{sex}")
Student selectByNameAndSex(@Param("name") String name, @Param("sex") Integer sex);

如果方法有多个参数，也可以不自定义param，MyBatis在方法的参数上就能为它们取自定义的名字，参数先以"param"作为前缀，再加上它们的参数位置作为参数别名，比如#{param1}、#{param2}。

// 默认使用param +参数序号或者0、1，值就是参数的值
@Select("select * from student where name=#{param1} and sex=#{param2}")
Student selectByNameAndSex(String name, Integer sex);

如果不想给每个参数命名，可以使用param参数，默认格式为param+参数序号或者0、1，值就是参数的值。

3.3 映射传值

需要传送多个参数时，也可以考虑使用映射（Map）的形式。

@Select("select * from student where name=#{name} and sex=#{sex}")
Student selectByNameAndSex(Map<String, Object> map);

在上面的示例中，将SQL语句需要的参数通过map类型传入，key为参数名，value为参数值。MyBatis会自动匹配对应的映射中的参数值。

调用时将参数依次加入映射中即可：

@Map param= new HashMap();
param.put("name", "ysxq");
param.put("sex", 1);
Student student = studentMapper.selectByNameAndSex(param);

3.4 使用pojo对象

使用pojo对象传参是比较常用的传参方式，像前面介绍的insert、update等方法，都是直接传入user对象。

@Update({
     "update student",
     "set name = #{name,jdbcType=VARCHAR},",
     "age = #{age,jdbcType=INTEGER},",
     "sex = #{sex,jdbcType=INTEGER}",
     "where id =#{id,jdbcType=VARCHAR}"
})
void update(Student record);

对于insert、update等参数较多的方法，可以使用pojo对象传参。需要注意的是，参数的名字和类型必须和pojo对象的属性保持一致。

上面讲述了MyBatis传参的4种方式，使用时根据方法的参数来选择合适的传值方式即可。

4.结果映射

MyBatis会自动将查询结果集转换为需要返回的数据类型，但是有些特殊的场景需要处理，比如查询的返回结果与期望的数据格式不一致时，应该怎么处理呢？

这就需要使用@Results和@Result注解。这两个注解可以将数据库中查询到的数值转化为具体的属性或类型，修饰返回的结果集，比如查询的对象返回值属性名和字段名不一致，或者对象的属性中使用了枚举等。

    @Select({
            "select",
            "id, name as student_name,age, sex as student_sex",
            "from student",
            "where id = #{id,jdbcType=VARCHAR}"
    })
    @Results({
            @Result(column="id",property="id",jdbcType= JdbcType.VARCHAR,id=true),
            @Result(column="student_name",property="name",jdbcType=JdbcType.VARCHAR),
            @Result(column="student_sex",property="sex",jdbcType=JdbcType.TIMESTAMP)
    })
    Student selectById(Long id);

在上面的例子中，查询结果集的student_name字段和实体类Student定义的name属性的名称不一致，所以需要Result进行转换；而age名称是一致的，所以不需要Result进行转换。