【SpringBoot】实验楼-如何使用 Spring Boot 整合 Mybatis 开发项目

      【SpringBoot】实验楼-如何使用 Spring Boot 整合 Mybatis 开发项目

项目结构

接下来学习使用 Spring Boot 整合 Mybatis，并且开发一个简单的 RESTful 风格的 Web 项目。

REST（英文：Representational State Transfer）描述了一个架构样式的网络系统，比如 Web 应用程序。它首次出现在 2000 年 Roy Fielding 的博士论文中，Roy Fielding 是 HTTP 规范的主要编写者之一。在目前主流的三种 Web 服务交互方案中，REST 相比于 SOAP（Simple Object Access protocol，简单对象访问协议）以及 XML-RPC 更加简单明了，无论是对 URL 的处理还是对 Payload 的编码，REST 都倾向于用更加简单轻量的方法设计和实现。值得注意的是 REST 并没有一个明确的标准，而更像是一种设计的风格。以上资料来自百度百科。

Pom文件

在 maven 的配置文件 pom.xml 中加入下面的依赖：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.shiyanlou</groupId>
    <artifactId>springboot</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>springboot</name>
    <description>Demo project for Spring Boot</description>

    <!--设置父模块 这样就可以继承父模块中的配置信息-->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.4.RELEASE</version>
        <relativePath/>
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
    <!--添加 web 依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.2</version>
        </dependency>

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

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

    <build>
        <plugins>
        <!--spirng Boot maven 插件-->
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

 

实体类Entity

在 com.shiyanlou.springboot.entity 中存放实体类，这里只建立了一个实体类 User.java。

package com.shiyanlou.springboot.entity;

import java.io.Serializable;


public class User implements Serializable{
  private Integer id;
  private String username;
  private String password;

  public Integer getId(){
    return id;
  }

  public void setId(Integer 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 "User{" +
            "id=" + id +
            ", username='" + username + '\'' +
            ", password='" + password + '\'' +
            '}';
  }
}

DAO层

BaseMapper.java

在 com.shiyanlou.springboot.dao 中建立 BaseMapper.java，用于提取常用的公共方法，减少重复代码。

package com.shiyanlou.springboot.dao;

import java.util.List;


public interface BaseMapper<T>{
  /**
   * 保存
   */
  Integer save(T t);

  /**
   * 删除
   */
  void delete(Integer id);

  /**
   * 通过 id 查询
   */
  T findById(Integer id);

  /**
   * 更新
   */
  void update(T t);

  /**
   * 返回所有信息
   */
  List<T> list();
}

UserMapper.java

在 com.shiyanlou.springboot.dao 中建立 UserMapper.java，UserMapper.java 继承 BaseMapper.java。

如果 BaseMapper.java 中的方法不足以满足需求，直接在 UserMapper.java 中添加对应的方法就可以了。

package com.shiyanlou.springboot.dao;

import com.shiyanlou.springboot.entity.User;

public interface UserMapper extends BaseMapper<User>{

}

UserMapper.xml

在 src/main/resources 中建立 mapper 文件夹，在 mapper 中建立 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.shiyanlou.springboot.dao.UserMapper">
  <select id="list" resultType="com.shiyanlou.springboot.entity.User">
    select *
    from user
  </select>
  <select id="findById" parameterType="int" resultType="com.shiyanlou.springboot.entity.User">
    select *
    from user
    where id = #{value}
  </select>
  <update id="update" parameterType="com.shiyanlou.springboot.entity.User">
    update user
      <set>
        <if test="username!=null and username!=''">
          username=#{username},
        </if>
        <if test="password!=null and password!=''">
          `password`=#{password}
        </if>
      </set>
    where id=#{id}
  </update>
  <delete id="delete" parameterType="int">
    delete
    from user
    where id = #{value}
  </delete>
  <insert id="save" parameterType="com.shiyanlou.springboot.entity.User" keyColumn="id" keyProperty="id" useGeneratedKeys="true">
    insert into user (username, `password`)
    values (#{username}, #{password})
  </insert>
</mapper>

Service层

将 service 常用的公共方法抽象出来，如简单的增删查改等功能，这样可以减少很多的重复代码。

IBaseService.java

在 com.shiyanlou.springboot.service 中建立 IBaseService.java：

package com.shiyanlou.springboot.service;

import java.util.List;


public interface IBaseService<T>{

  /**
   * 保存
   */
    Integer save(T t);

  /**
   * 删除
   */
  void delete(Integer id);

  /**
   * 通过 id 查询
   */
  T findById(Integer id);

  /**
   * 更新
   */
  void update(T t);

  /**
   * 返回所有信息
   */
  List<T> list();
}

BaseServiceImpl.java

在 com.shiyanlou.springboot.service.impl 包中建立 BaseServiceImpl.java， BaseServiceImpl.java 作为 IBaseService.java 的实现类，用于实现公共的增删查改等功能。

package com.shiyanlou.springboot.service.impl;

import com.shiyanlou.springboot.dao.BaseMapper;
import com.shiyanlou.springboot.service.IBaseService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.transaction.annotation.Transactional;

import java.util.List;

@Transactional(rollbackFor = Exception.class)
public abstract class BaseServiceImpl<T> implements IBaseService<T>{

  @Autowired
  protected BaseMapper<T> baseMapper;

  @Override
  public void delete(Integer id){
    baseMapper.delete(id);
  }

  @Override
  public Integer save(T t){
    return baseMapper.save(t);
  }

  @Override
  public void update(T t){
    baseMapper.update(t);
  }

  @Override
  public T findById(Integer id){
    return baseMapper.findById(id);
  }


  @Override
  public List<T> list(){
    return baseMapper.list();
  }
}

IUserService.java

在 com.shiyanlou.springboot.service 中建立 IUserService.java。

IUserService.java 用于定义与 User 相关的业务功能，如果要自定义业务功能，直接在 IUserService.java 添加新的方法，然后在 UserServiceImpl.java 中实现即可。

package com.shiyanlou.springboot.service;

import com.shiyanlou.springboot.entity.User;

public interface IUserService extends IBaseService<User>{

}

UserServiceImpl.java

在 com.shiyanlou.springboot.service.impl 中建立 UserServiceImpl.java，UserServiceImpl.java 用于实现和 User 有关的业务逻辑。如果对 BaseServiceImpl.java 提供的公用增删查改功能不满意，可以选择直接覆盖或者新填一个方法。

package com.shiyanlou.springboot.service.impl;

import com.shiyanlou.springboot.entity.User;
import com.shiyanlou.springboot.service.IUserService;
import org.springframework.stereotype.Service;

@Service
public class UserServiceImpl extends BaseServiceImpl<User> implements IUserService{

}

Controller层

在 com.shiyanlou.controller 中建立 UserController.java：

package com.shiyanlou.springboot.controller;

import com.shiyanlou.springboot.entity.User;
import com.shiyanlou.springboot.service.IUserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping("user")
public class UserController{

  private final IUserService userService;

  @Autowired
  public UserController(IUserService userService){
      this.userService = userService;
  }


  // 使用 post 请求新建
  @PostMapping()
  public String save(User user){
    userService.save(user);
    return "save success";
  }

  // 使用 put 请求更新，会拦截类似 /user/1 这种形式的路径
  @PutMapping("{id}")
  public String update(User user, @PathVariable int id){
    // 当数据不存在时，不允许更新
    if (userService.findById(id) == null){
      return "Not Exist";
    }
    // 防止传入的 id 不一致，如 user 中 id 属性是 2，而 url 路径中 id 为 1
    if (user.getId() != id){
      return "Unmatched parameters";
      }
    userService.update(user);
    return "update success";
  }

  // 使用 delete 请求删除
  @DeleteMapping("{id}")
  public String delete(@PathVariable int id){
    userService.delete(id);
    return "delete success";
  }

  // 使用 get 方法查询
  @GetMapping()
  public List<User> list(){
    return userService.list();
  }

  // 使用 get 方法查询单个数据
  @GetMapping("{id}")
  public User getById(@PathVariable int id){
    return userService.findById(id);
  }
}

application.properties、SpringbootApplication.java 和 mysql 数据库

完成上面的代码后需要将 Mybatis 和 Spring Boot 整合，需要配置 Mybatis 的 mapper 接口位置和 xml 文件的位置，只需要两个代码文件就可以完成整合。

application.properties

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

#mapper  xml文件位置
mybatis.mapper-locations=classpath:mapper/*.xml

SpringbootApplication.java

package com.shiyanlou.springboot;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
// 扫描 mapper 接口位置
@MapperScan(basePackages = {"com.shiyanlou.springboot.dao"})
public class SpringbootApplication{

  public static void main(String[] args){
    SpringApplication.run(SpringbootApplication.class, args);
  }
}

mysql 数据库配置

打开终端，启动 mysql 服务：

sudo service mysql start

进入数据库：

mysql -u root

创建数据库 test，并且查看数据库是否创建成功：

create database test;
show databases;

切换到数据库 test，创建数据表user：

use test;
CREATE TABLE user
(
  id int PRIMARY KEY AUTO_INCREMENT,
  username varchar(50),
  password varchar(50)
);