spring-boot-route整合jdbcTemplate操作数据库+整合mybatis操作数据库

Posted 2023-02-10

在一部分内容中，我们学习了Restful接口的编写，及接口文档的生成。我们需要将接口数据进行持久化存储，这一部分我们主要学习几种持久化框架将数据进行存储。本部分内容中，我们都将使用mysql为例来做为演示数据库。

在刚开始接触数据库操作的时候我们都会使用JDBC来进行数据库操作，但是每次都要创建连接，关闭连接非常麻烦，Spring将JDBC进行了简易的封装成了一个新的框架——JdbcTemplate。

项目搭建

1 添加mysql依赖

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.11</version>
</dependency>

2. 添加jdbcTemplate依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>

3. 配置mysql

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/simple_fast?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai&zeroDateTimeBehavior=CONVERT_TO_NULL&useSSL=false&useAffectedRows=true&allowPublicKeyRetrieval=true
    username: root
    password: root

简单操作数据库

新建一张表​​student​​用来测试JdbcTemplate的常用功能。建表语句如下：

CREATE TABLE `student` (
   `student_id` int(30) NOT NULL,
   `age` int(1) DEFAULT NULL COMMENT 年龄,
   `name` varchar(45) DEFAULT NULL COMMENT 姓名,
   `sex` int(1) DEFAULT NULL COMMENT 性别：1：男，2：女，0：未知,
   `create_time` datetime DEFAULT NULL COMMENT 创建时间,
   `status` int(1) DEFAULT NULL COMMENT 状态：1：正常，-1：删除,
   PRIMARY KEY (`student_id`)
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 CHECKSUM=1 DELAY_KEY_WRITE=1 ROW_FORMAT=DYNAMIC COMMENT=学生表

对应的实体类如下：

@Data
@NoArgsConstructor
@AllArgsConstructor
public class StudentBean implements Serializable 
    
    private static final long serialVersionUID = 4618004018169112427L;

    private Integer studentId;
    private Integer age;
    private String name;
    private Integer sex;
    private Date createTime;
    private Integer status;

JdbcTemplate提供了比较完善的数据库操作API，日常开发中比较常用的API主要为两类，分别是

• query与queryXXX
• update与batchUpdate

JdbcTemplate的使用也非常简单，哪儿需要使用注入即可

@Autowired
private JdbcTemplate jdbcTemplate;

1 查询单个实体

public StudentBean getStudent(int status)
    String sql = "select * from student where status = ? limit 1";
    return jdbcTemplate.queryForObject(sql,new Object[]status,new BeanPropertyRowMapper<>(StudentBean.class));

2 查询List集合

public List<StudentBean> studentBeanList(int status)
    String sql = "select * from student where status = ?";
    return  jdbcTemplate.query(sql,new Object[]status,new BeanPropertyRowMapper<>(StudentBean.class));

3. 删除操作

public int deleteStudent(int status)
    String sql = "delete from student where status = 0";
    return jdbcTemplate.update(sql);

4. 更新操作

public int updateStudent(int studentId,String name)
    String sql = "update student set name = ? where student_id = ?";
    return jdbcTemplate.update(sql,new Object[]name,studentId);

5. 插入操作

public int addStudent()
    String sql = "insert into student(student_id,age,name,status) values(?,?,?,?)";
    return jdbcTemplate.update(sql,new Object[]30,18,"Java旅途",0);

6. 批量插入

JdbcTemplate提供了批量插入的API，为了减少与数据库的操作，提高插入效率，将待插入的数据批量放在缓冲区，一次批量插入多条数据。

public int batchAddStudent()

    // 构造list集合
    List<StudentBean> studentBeanList = new ArrayList<>();
    StudentBean studentBean = new StudentBean(31, 31, "Java旅途", 1, new Date(), 1);
    StudentBean studentBean1 = new StudentBean(32, 32, "javatrip", 1, new Date(), 1);
    studentBeanList.add(studentBean);
    studentBeanList.add(studentBean1);
    String sql = "insert into student values(?,?,?,?,?,?)";

    int[] ints = jdbcTemplate.batchUpdate(sql, new BatchPreparedStatementSetter() 
        @Override
        public void setValues(PreparedStatement ps, int i) throws SQLException 
            StudentBean student = studentBeanList.get(i);
            ps.setInt(1, student.getStudentId());
            ps.setInt(2, student.getAge());
            ps.setString(3, student.getName());
            ps.setInt(4, student.getSex());
            ps.setDate(5,new java.sql.Date(System.currentTimeMillis()));
            ps.setInt(6, student.getStatus());
        

        @Override
        public int getBatchSize() 
            return studentBeanList.size();
        
    );
    return ints.length;

上面只是演示了几个简单的例子，如果需要更详细的用法可以参考官方提供的JdbcTemplate API。JdbcTemplate对于初学者来说是比较容易上手的一个框架，使用起来也非常方便。但是也存在一些缺点，它是将sql硬编码到java代码中，如果需要修改sql，就需要重新编译java代码，不利于维护。

》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》

​

​

接下来讲解：

【spring-boot-route（八）整合mybatis操作数据库】

MyBatis 是一款优秀的持久层框架，它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以使用简单的 XML 或注解来配置和映射原生信息，将接口和 Java 的 POJOs(Plain Ordinary Java Object,普通的 Java对象)映射成数据库中的记录。

通过注解完成数据操作

第一步：引入mysql依赖和mybatis依赖

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>LATEST</version>
</dependency>

第二步：新建学生表及对应的实体类

CREATE TABLE `student` (
   `student_id` int(30) NOT NULL AUTO_INCREMENT,
   `age` int(1) DEFAULT NULL COMMENT 年龄,
   `name` varchar(45) DEFAULT NULL COMMENT 姓名,
   `sex` int(1) DEFAULT NULL COMMENT 性别：1：男，2：女，0：未知,
   `create_time` datetime DEFAULT NULL COMMENT 创建时间,
   `status` int(1) DEFAULT NULL COMMENT 状态：1：正常，-1：删除,
   PRIMARY KEY (`student_id`)
 ) ENGINE=InnoDB AUTO_INCREMENT=617354 DEFAULT CHARSET=utf8mb4 CHECKSUM=1 DELAY_KEY_WRITE=1 ROW_FORMAT=DYNAMIC COMMENT=学生表

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Student implements Serializable 

    private static final long serialVersionUID = 6712540741269055064L;

    private Integer studentId;
    private Integer age;
    private String name;
    private Integer sex;
    private Date createTime;
    private Integer status;

第三步：配置数据库连接信息

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/simple_fast
    username: root
    password: root

增删改查

@Mapper
public interface StudentMapper 

    @Select("select * from student where student_id = #studentId")
    Student findById(@Param("studentId") Integer studentId);

    @Insert("insert into student(age,name) values(#age,#name)")
    int addStudent(@Param("name") String name,@Param("age") Integer age);

    @Update("update student set name = #name where student_id = #studentId")
    int updateStudent(@Param("studentId") Integer studentId,@Param("name") String name);

    @Delete("delete from student where student_id = #studentId")
    int deleteStudent(@Param("studentId") Integer studentId);

上面演示的传参方式是通过单个参数传递的，如果想通过Map或实体类传参数，就不需要使用@Param来绑定参数了，将map中的key或者实体类中的属性与sql中的参数值对应上就可以了。

通过XML配置完成数据操作

@Mapper和@MapperScan

@Mapper加在数据层接口上，将其注册到ioc容器上，@MapperScan加在启动类上，需要指定扫描的数据层接口包。如下：

@Mapper
public interface StudentMapper 

@SpringBootApplication
@MapperScan("com.javatrip.mybatis.mapper")
public class MybatisApplication 
    public static void main(String[] args) 
        SpringApplication.run(MybatisApplication.class, args);
    

两个注解的作用一样，在开发中为了方便，通常我们会使用@MapperScan。

指定mapper.xml的位置

mybatis:
  mapper-locations: classpath:mybatis/*.xml

开启数据实体映射驼峰命名

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

编写xml和与之对应的mapper接口

<?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.javatrip.mybatis.mapper.StudentXMapper">
    <select id="findById" resultType="com.javatrip.mybatis.entity.Student">
        select * from student where student_id = #studentId
    </select>
    <insert id="addStudent" parameterType="com.javatrip.mybatis.entity.Student">
        insert into student(name,age) values(#name,#age)
    </insert>
    
    <update id="updateStudent" parameterType="com.javatrip.mybatis.entity.Student">
        update student set name = #name where  student_id = #studentId
    </update>

    <delete id="deleteStudent" parameterType="Integer">
        delete from student where student_id = #studentId
    </delete>
</mapper>

@Mapper
public interface StudentXMapper 

    Student findById(@Param("studentId") Integer studentId);

    int addStudent(Student student);

    int updateStudent(@Param("studentId") Integer studentId,@Param("name") String name);

    int deleteStudent(@Param("studentId") Integer studentId);

编写测试类

这里有几个需要注意的点：mapper标签中namespace属性对应的是mapper接口；select标签的id对应mapper接口中的方法名字；select标签的resultType对应查询的实体类，使用全路径。