《Gradle构建SpringBoot学习笔记》第四章：Spring Boot集成mybatis

本是古典何须时尚 2022-05-13 16:57 475阅读 0赞

## 1.MySQL数据库 ##

#### 1.1数据库结构： ####

![数据库结构.png][.png]

#### 1.2user表结构： ####

![user结构.png][user_.png]

#### 1.3user表数据： ####

![user数据.png][user_.png 1]

#### 1.4commodity表结构： ####

![commodity结构.png][commodity_.png]

#### 1.5commodity表数据： ####

![commodity数据.png][commodity_.png 1]

## 2.使用注解方式实现Mybatis ##

#### 2.1引入依赖jar包 ####

在build.gradle中添加Mysql驱动及Mybatis所需jar包如下

dependencies {
    	compile('org.springframework.boot:spring-boot-starter')
    testCompile('org.springframework.boot:spring-boot-starter-test')
    //使用 Controller 的时候需要引入 web 包
        compile('org.springframework.boot:spring-boot-starter-web')
    
    compile 'mysql:mysql-connector-java' 
    //配置mybatis 数据源
        compile("org.mybatis.spring.boot:mybatis-spring-boot-starter:1.3.0")
        testCompile('org.mybatis.spring.boot:mybatis-spring-boot-starter-test:1.3.0')
    }

#### 2.2配置数据库连接 ####

将src/main/resources中的application.properties重命名为application.yml，并打开编辑配置项目所需数据库的地址、用户名、密码，格式如下

spring:
      datasource:
        url: jdbc:mysql://localhost:3306/boot_db?characterEncoding=utf8
        username: root
        password: 123456

#### 2.3创建web项目各层级包 ####

在src/main/java中的创建entity、mapper、service、web的package包如下  
![package.png][]

#### 2.4编写Mapper接口 ####

在刚刚建的mapper包中新建interface接口UserMapper，并以注解方式添加一个查询方法如下

import org.apache.ibatis.annotations.Select;
    
    public interface UserMapper {
    
    	@Select("select name from user where id = #{id}")
    	String findUsername(Long id);
    }

#### 2.5编写Service层 ####

在service包中new一个interface接口UserService.java，包含一个查询方法如下

public interface UserService {
    	String findUsername(Long id);
    }

在service包中创建impl包，并创建接口实现类UserServiceImpl.java  
![UserServiceImpl.png][]

UserService的实现类UserServiceImpl具体代码如下

@Service
    public class UserServiceImpl implements UserService {
    
    	@Autowired
    	private UserMapper userMapper;
    
    	@Override
    	public String findUsername(Long id) {
    		String name = userMapper.findUsername(id);
    		return name;
    	}
    }

实现类需加@Service注解，并将UserMapper用@Autowired注入。

#### 2.6编写Controller层 ####

在Web包中创建Controller类如下

#### 2.7运行测试 ####

打开Application启动类，去掉之前步骤中测试使用的接口代码，  
并为该类添加Mapper扫描注解，修改后代码如下

@MapperScan("com.dmcq.mapper")
    @SpringBootApplication
    public class DmcqApplication {
    
    	public static void main(String[] args) {
    		SpringApplication.run(DmcqApplication.class, args);
    	}
    }

运行该类main方法启动服务，控制台输出信息如下，显示出了服务启动的端口（8080），则服务启动成功。  
![启动成功.png][.png 1]

服务启动成功后，浏览器get方式传参请求Controller层web接口，测试请求根据id查询数据库中用户姓名的功能：  
浏览器测试访问http://localhost:8080/user/userName?id=1结果如下  
![浏览测试.png][.png 2]

根据id查询数据库中用户姓名功能完成，测试成功。

## 3.使用XML方式实现Mybatis ##

在2的基础上进行以下操作

#### 3.1创建实体类 ####

在entity包中创建实体类User如下

public class User {
    	private long id ;               //id
    	private String name;		// 姓名
    	
    public Long getId() {
    		return id;
    	}
    	public void setId(Long id) {
    		this.id = id;
    	}
    	public String getName() {
    		return name;
    	}
    	public void setName(String name) {
    		this.name = name;
    	}
    }

#### 3.2添加Mapper接口 ####

打开2.4中创建的UserMapper接口类，根据需求添加一个接口方法get（）如下

public interface UserMapper {
    
    	@Select("select name from user where id = #{id}")
    	String findUsername(Long id);
    
    	User get(User user);
    }

#### 3.3创建XML文件 ####

（1）创建mappers文件夹  
在src/main/resources下创建mappers文件夹：  
右击resources→New→other  
![folder.png][]

选择Folder,点击Next  
![mappers.png][]

将Folder name命名为mappers，点击Finish完成创建文件夹。  
（2）创建UserMapper.xml  
在新建的mappers文件夹下创建UserMapper.xml文件，如下  
![UserServiceImpl.png][UserServiceImpl.png 1]

打开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.dmcq.mapper.UserMapper">
        
        <sql id="userColumns">
    		a.id AS "id",
    		a.name AS "name"
    	</sql>
    	
        <select id="get" resultType="User">
    		SELECT 
    			<include refid="userColumns"/>
    		FROM user a
    		WHERE a.id = #{id}
    	</select>
    </mapper>

中的id值对应4.2.2中添加的get（）方法。

#### 3.4添加service层测试方法 ####

打开UserService.java，添加一个接口方法，如下

public interface UserService {
    	String findUsername(Long id);
    	User getUser(User user);
    }

打开UserServiceImpl.java，添加实现方法，如下

@Service
    public class UserServiceImpl implements UserService {
    	@Autowired
    	private UserMapper userMapper;
    	@Override
    	public String findUsername(Long id) {
    		String name = userMapper.findUsername(id);
    		return name;
    	}
    	@Override
    	public User getUser(User user) {
    		user = userMapper.get(user);
    		return user;
    	}
    }

#### 3.5添加Controller层测试方法 ####

打开UserController.java，添加一个方法

@RestController
    @RequestMapping(value = "user")
    public class UserController {
    
    	@Autowired
    	private UserService userService;
    
    	@RequestMapping("/userName")
    	String findUserNameById(Long id) {
    		String name = userService.findUsername(id);
    		return name;
    	}
    
    	@RequestMapping("/findUserNameByUser ")
    	String findUserNameByUser(User user) {
    		String name = userService.getUser(user).getPersonName();
    		return name;
    	}
    }

#### 3.6配置Mybatis ####

打开src/main/resources的下application.yml添加mybatis配置如下

spring:
      datasource:
        url: jdbc:mysql://localhost:3306/boot_db?characterEncoding=utf8
        username: root
        password: 1234
        
    mybatis:
        type-aliases-package: com.dmcq.entity
        mapper-locations: classpath:mappers/**/*.xml
        check-config-location: true

type-aliases-package配置别名为实体类所在包，若未配置则xml文件中标签的返回值类型resultType="User"必须写成全类名形式resultType=“com.dmcq.entity.User”，否则会因为找不到User的定义位置而报错。

#### 3.7运行测试 ####

右键点击Application.java启动类  
Run As/Debug As→Java Application，启动web服务  
![运行.png][.png 3]

浏览器访问  
[http://localhost:8080/user/findUserNameByUser?id=2][http_localhost_8080_user_findUserNameByUser_id_2]  
结果如下  
![测试成功.png][.png 4]

测试成功。

[.png]: /images/20220504/6b2380ac8b7f4cbe87a7fa5a7d566c72.png
[user_.png]: /images/20220504/f48963598b3f46b8b98dc4aa266a6dcb.png
[user_.png 1]: /images/20220504/18a96ab88b794623970af6fd0aaf9bca.png
[commodity_.png]: /images/20220504/cbb5c19169be45e4a40cad094dd8f68f.png
[commodity_.png 1]: /images/20220504/6b4a24fa0830422bbecbaeb8e086c944.png
[package.png]: /images/20220504/c04ee3ebdced4dcb8624e4a0515e9bb5.png
[UserServiceImpl.png]: /images/20220504/edf362a2c4a54f0e8cf372d4e92abd21.png
[.png 1]: /images/20220504/25f8f25c7d0746459bbea9fbd79acc2f.png
[.png 2]: /images/20220504/32e932b57ce7464e8b979c542088855a.png
[folder.png]: /images/20220504/d1c0335f0e9547ca9e39c3b68772690b.png
[mappers.png]: /images/20220504/1e4bf74791f44e338f39e3b4529ee95d.png
[UserServiceImpl.png 1]: /images/20220504/3b3914132b084991b03e3275f8f4f3be.png
[.png 3]: /images/20220504/b45756f5430645e3abc589afab8f588e.png
[http_localhost_8080_user_findUserNameByUser_id_2]: http://localhost:8080/user/findUserNameByUser?id=2
[.png 4]: /images/20220504/2f1687fb2d544009803e7088d7431c0a.png