Spring Boot整合Mybatis并完成CRUD操作的实现示例

程序员文章站 2024-03-03 22:36:04

mybatis 是一款优秀的持久层框架，被各大互联网公司使用，本文使用spring boot整合mybatis，并完成crud操作。为什么要使用mybatis？我们需要...

mybatis 是一款优秀的持久层框架，被各大互联网公司使用，本文使用spring boot整合mybatis，并完成crud操作。

为什么要使用mybatis？我们需要掌握mybatis吗？

说的官方一点：

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

说的功利一点：

据说目前各大互联网公司通常使用mybatis，还不赶快学习一下吗？

怎么使用？

这才是本文的重点。

新建spring boot工程和导入eclipse这些在这里就不啰嗦了，不会的可以查看只需两步！eclipse+maven快速构建第一个spring boot项目。

1. pom.xml添加依赖

spring boot整合mybatis需要引入 mybatis-spring-boot-starter；我使用的是mysql数据库，需要引入ysql-connector-java。

<!-- mysql驱动 -->
    <dependency>
      <groupid>mysql</groupid>
      <artifactid>mysql-connector-java</artifactid>
    </dependency>
      
    <!-- spring-boot整合mybatis -->
    <dependency>
      <groupid>org.mybatis.spring.boot</groupid>
      <artifactid>mybatis-spring-boot-starter</artifactid>
      <version>1.1.1</version>
    </dependency>

2. application.property配置mybatis和数据源

mybatis.config-location=classpath:mapper/mybatis_config.xml
mybatis.mapper-locations=classpath:mapper/*mapper.xml
mybatis.type-aliases-package=com.shangguan.mybatis.entity

spring.datasource.driverclassname = com.mysql.cj.jdbc.driver
spring.datasource.url = jdbc:mysql://localhost:3306/spring_boot?servertimezone=gmt%2b8
spring.datasource.username = root
spring.datasource.password = 123456

例如我的mybatis_config.xml的路径为/mybatis/src/main/resources/mapper/mybatis_config.xml（下面是目录结构图），那么我的mybatis.config-location配置为classpath:mapper/mybatis_config.xml，请注意一定要根据自己项目的目录结构进行配置mybatis。数据库也一样。

mapper包里面是mybatis的映射类。

interceptor包是拦截器，如果还有疑问请参考之前的博文：spring boot配置拦截器及实现跨域访问

Spring Boot整合Mybatis并完成CRUD操作的实现示例

3. mybatis全局配置文件

mybatis 的配置文件包含了会深深影响 mybatis 行为的设置（settings）和属性（properties）信息。关于配置文件的详解请看。

mybatis_config.xml

<?xml version="1.0" encoding="utf-8" ?>
<!doctype configuration public "-//mybatis.org//dtd config 3.0//en" "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>

</configuration>

4. 实体类user

user使用的和之前使用的一样，没有修改。

user：

public class user implements serializable {

  private static final long serialversionuid = 1l;
  private long id;
  private string username;
  private string password;

  public user() {
    super();
  }

  public user(string username, string password) {
    super();
    this.username = username;
    this.password = password;
  }

  public long getid() {
    return id;
  }

  public void setid(long id) {
    this.id = id;
  }

  public string getusername() {
    return username;
  }

  public void setusername(string username) {
    this.username = username;
  }

  public string getpassword() {
    return password;
  }

  public void setpassword(string password) {
    this.password = password;
  }

  @override
  public string tostring() {
    return "username " + this.username + ", pasword " + this.password;
  }
}

5. 添加user的映射文件和映射类

sql 映射文件有很少的几个*元素（按照它们应该被定义的顺序）：

cache – 给定命名空间的缓存配置。
cache-ref – 其他命名空间缓存配置的引用。
resultmap – 是最复杂也是最强大的元素，用来描述如何从数据库结果集中来加载对象。
parametermap – 已废弃！老式风格的参数映射。内联参数是首选,这个元素可能在将来被移除，这里不会记录。
sql – 可被其他语句引用的可重用语句块。
insert – 映射插入语句
update – 映射更新语句
delete – 映射删除语句
select – 映射查询语句

更多信息请参考。

增删改查的sql语句在usermapper.xml里面书写，具体的看代码，里面有注释。

有几点需要注意的地方：

①<select id="getall" resulttype="user">，这里的id的名字是自己取的，但是要和usermapper.java里面的名字相同public list<user> getall();

②当sql语句中有多个参数的时候，需要在映射类方法里面加@param的注解，不然会抛出异常说找不到参数。例如：

public void updateuser(@param("id") long id, @param("username") string username,
      @param("password") string password);

③主键自增，需要设置usegeneratedkeys="true" keyproperty="id"

usermapper.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.shangguan.mybatis.mapper.usermapper">
   <resultmap id="baseresultmap" type="com.shangguan.mybatis.mapper.usermapper" >
    <id column="id" property="id" jdbctype="bigint" />
    <result column="username" property="username" jdbctype="varchar" />
    <result column="password" property="password" jdbctype="varchar" />
  </resultmap>
  
  <!--查询所有-->
  <select id="getall" resulttype="user">
    select * from user
  </select>
  
  <!--保存用户-->
  <insert id="saveuser" usegeneratedkeys="true" keyproperty="id">
    insert into user(username,password) values(#{username},#{password})
  </insert>
  
  <!--通过id删除用户-->
  <delete id="deleteuserbyid">
    delete from user where id =#{id}
  </delete>
  
  <!--更新该用户信息-->
  <update id="updateuser">
    update user set username = #{username},password = #{password}
    where id = #{id}
  </update>
  
</mapper>

映射类usermapper.java：

@mapper
public interface usermapper {
  public list<user> getall();
  public void saveuser(user user);
  public void deleteuserbyid(long id);
  public void updateuser(@param("id") long id, @param("username") string username,
      @param("password") string password);
}

6. service层实现

userservice里面有四个方法：增删改查。查询所有的用户，保存用户，通过id删除用户，更新用户信息。

userservice：

public interface userservice {

  public list<user> getalluser();
  public void saveuser(user user);
  public void deleteuserbyid(long id);
  public void updateuser(long id, string username, string password);

}

userserviceimpl：

@service
public class userserviceimpl implements userservice {

  @autowired
  private usermapper usermapper;

  @override
  public list<user> getalluser() {
    list<user> list = usermapper.getall();
    return list;
  }

  @override
  public void saveuser(user user) {
    usermapper.saveuser(user);
  }

  @override
  public void deleteuserbyid(long id) {
    usermapper.deleteuserbyid(id);
  }

  @override
  public void updateuser(long id, string username, string password) {
    usermapper.updateuser(id, username, password);
  }
}

7. controller层实现

usercontroller里面对接口进行封装：

@restcontroller
@springbootapplication
@requestmapping("/mybatis")
public class usercontroller {

  @autowired
  private userservice userservice;

  @requestmapping("/getalluser")
  public list<user> getalluser() {
    list<user> list = userservice.getalluser();
    return list;
  }

  @requestmapping("/saveuser")
  public void saveuser(user user) {
    userservice.saveuser(user);
  }

  @requestmapping("/deleteuserbyid")
  public void deleteuserbyid(long id) {
    userservice.deleteuserbyid(id);
  }

  @requestmapping("/updateuser")
  public void updateuser(long id, string username, string password) {
    userservice.updateuser(id, username, password);
  }
}

8. 测试

启动spring boot项目，使用postman进行测试：

① http://localhost:8080/mybatis/getalluser 获取所有的用户信息

Spring Boot整合Mybatis并完成CRUD操作的实现示例