springboot整合mybatis注解版与XML配置版

最新推荐文章于 2021-03-30 08:19:04 发布

suxinhaixp

最新推荐文章于 2021-03-30 08:19:04 发布

阅读量157

点赞数

分类专栏： springboot

springboot 专栏收录该内容

5 篇文章 0 订阅

订阅专栏

在spring中，构建一个项目，最麻烦也最容易出错的莫过于各种xml文件的配置，即使是一个简单的demo也需要花费一定量的时间去搭建与配置环境，而springboot可以直接理解为一个轻量级但功能依旧强大的spring，只需要填写必要的配置文件，其余的springboot帮你全搞定，简直赞的不行。接下来，开始springboot之旅吧。

1、项目的构建
在idea中菜单栏，file–>Spring Initializr
点击next之后，在接下来的页面填写”Group”与”Artifact”，next之后的Dependencies依赖项页面时，选择Web->Web,SQL->MyBatis,MySQL

在随后的页面中填写项目名与项目路径，项目便初步完成了。随后在java下你所建的包的下面添加controller，entity，mapper（为简化演示起见，没有建service层），建好的目录结构如下

java中放置各类后台源码，resource存放资源文件，static存放前端的静态文件，templates存放html文件，application.properties里是各类配置信息，诸如数据源的配置等。

2、配置文件
<1>pom.xml引入依赖
打开最底端的pom.xml文件，发现程序已经自动为你配置好了一些依赖项，但有时我们需要用到json格式，热部署之类的，依旧需要自己添加一些依赖项。笔者的该Demo的完整依赖项如下(注：热部署加了依赖项后还需要进行设置，请自行百度)

<dependencies>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.3.1</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>

<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>

<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.40</version>
</dependency>

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<optional>true</optional>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration> 
<fork>true</fork>
<addResources>true</addResources>
</configuration>
</plugin>
</plugins>
</build>

<2>application.properties配置
在该文件里可以进行很多配置，包的扫描，xml文件的映射，单个或多个数据源的配置等等，如下便是数据源MySql的配置

spring.datasource.url=jdbc:mysql://localhost:3306/自建的库名?useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC&useSSL=true
spring.datasource.username=root
spring.datasource.password=自设的密码
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

至此，所有的配置文件都配置完了，相比较spring各类繁重的配置文件来说，是不是轻松了一大截。

3、注解版的后台代码
<1>entity层与数据库表处理
hibernate只需要在MySQL中建立一个库，设置好对应的实体类，在运行的过程中，程序会自动生成实体类对应的表。然而mybatis没这么“智能”，还需要我们自动去建表，库都是需要自己见的。首先在entity层建一个实体类User.java如下

public class User implements Serializable {

private int id;

private String userName;

private String password;

private String authority;

private String phone;

//各类字段对应的set与get方法
xxxxx
}

接下来，在MySQL中建库、建表

create database bootDemo; //库名
drop table if exists `user`;
create table `user`( //表名
`id` int(10) unsigned not null auto_increment,
`user_name` varchar(20) not null,
`password` varchar(20) default null,
`authority` varchar(20) default null,
`phone` varchar(11) default null,
primary key (`id`)
)engine=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;

注意，表中的字段user_name对应实体类的userName，如果不做处理，那么程序是无法识别的，在mapper层中，笔者给出了一种解决方案，当然您也可以使用网上的其他解决方案。至此，实体层的处理就结束了。

<2>controller层
控制层的主要作用是将有前端发送过来的访问请求，转发给相应的model进行处理，并返回结果。在controller包新建一个java类，UserController类，添加代码如下

@RestController
@EnableTransactionManagement
public class UserController {

@Autowired
private UserMapper userMapper;

@RequestMapping("/all")
public JSONObject findAll(){
List<User> userList = userMapper.findAll();
JSONObject json =new JSONObject();
json.put("data",userList);
return json;
}

@RequestMapping("/add")
public void addOne(User user){
userMapper.addOne(user);
}

@RequestMapping("/update")
public JSONObject update(User user){
userMapper.update(user);
JSONObject json =new JSONObject();
json.put("data",user);
return json;
}

@RequestMapping("/find")
public JSONObject findOne(int id){
User user = userMapper.findOne(id);
JSONObject json =new JSONObject();
json.put("data",user);
return json;
}

@RequestMapping("/del")
public void delOne(int id){
userMapper.delOne(id);
}

}

加@RestController注解那么返回的结果会自动解析为json格式的字段，如果加@Controller注解，那么图中”return json;”便会解析为json.html，并去寻找该页面，而不是返回json中的内容。@EnableTransactionManagement为加事务管理。@RequestMapping(“/all”)注解为路劲映射，在浏览器中输入localhost:8080/all便会定位到该函数，并会把存放在json中的结果输出到页面
<3>mapper层
在mybatis中，该层是直接连接并操作数据库的接口。对数据库的各类操作均在这个接口里面定义并完成。在mapper包下新建**接口**UserMapper.java，编写代码如下

@Mapper
public interface UserMapper{
// mybatis中数据库不能自动识别大写字母，如userName，它只认识user_name，因此需要转换
@Select("SELECT * FROM user")
@Results({
@Result(column = "user_name",property = "userName")
})
List<User> findAll();

@Insert("INSERT INTO user(userName,password,authority,phone) VALUES (#{userName},#{password},#{authority},#{phone})")
@Results({
@Result(column = "user_name",property = "userName")
})
void addOne(User user);

@Update("UPDATE user SET userName=#{userName},password=#{password},authority=#{authority},phone=#{phone} where id=#{id}")
@Results({
@Result(column = "user_name",property = "userName")
})
void update(User user);

@Select("SELECT * FROM user WHERE id=#{id}")
User findOne(int id);

@Delete("DELETE FROM user WHERE id=#{id}")
void delOne(int id);
}

首先定义某个接口，诸如查询所有List findAll()，这个是与controller层一一对应的。定义接口，加注解进行实现@Select(“SELECT * FROM user”)，mybatis会进行操作并把结果返回。之所以加如下代码

@Results({
@Result(column = "user_name",property = "userName")
})

是因为实体类并不认识user_name，它只认识userName，所以进行转换。至此，你便可以打开浏览器，输入路劲，奇迹的一刻便会出现。

4、XML配置文件版
配置文件版与注解版相比，要稍微复杂一点，两者的区别仅为mapper层处理的处理方式不一样，因此实体层与控制层，数据库等均相同。首先来看xml版的mapper

List<User> findAll();

User findOne(Integer id);

void addOne(User user);

void updateOne(User user);

void delOne(Integer id);

很明显，没了诸如@Select(“SELECT * FROM user”)的注解，其是把该过程令放在一个xml文件中，当我们访问到mapper层中的findALL()接口，便通过映射的方式将访问传递到xml文件中，由对应的处理字段进行处理。因此，我们需要在resources资源文件夹下新建映射的xml文件

如图，笔者新建了一个mybatis文件夹，新建config.xml定义文件，再新建mapper文件夹，存放UserMapper接口的映射文件。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>
<typeAliases>
<typeAlias alias="Integer" type="java.lang.Integer" />
<typeAlias alias="Long" type="java.lang.Long" />
<typeAlias alias="HashMap" type="java.util.HashMap" />
<typeAlias alias="LinkedHashMap" type="java.util.LinkedHashMap" />
<typeAlias alias="ArrayList" type="java.util.ArrayList" />
<typeAlias alias="LinkedList" type="java.util.LinkedList" />
</typeAliases>
</configuration>

接下来，我们再来看处理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.spring.mybatisxml.mapper.UserMapper1" >

<sql id="Base_Column_List" >id, userName, authority</sql>

<select id="findAll" resultMap="BaseResultMap" >
SELECT
<include refid="Base_Column_List" />
FROM user
</select>

<select id="findOne" resultMap="BaseResultMap">
SELECT * FROM user WHERE id=#{id}
</select>

<insert id="addOne">
INSERT INTO user(userName,authority) VALUES (#{userName},#{authority})
</insert>

<update id="updateOne">
UPDATE user SET userName=#{userName},authority=#{authority} WHERE id=#{id}
</update>

<delete id="delOne">
DELETE FROM user WHERE id=#{id}
</delete>

</mapper>

是不是挺熟悉的，各类sql操作语句，注意代码中的id与UserMapper接口中定义的接口保持一致。那么，程序怎么知道要从接口UserMapper.java映射到UserMapper.xml文件呢？自然是要在application.properties中进行配置了，再在其中加如下语句就可以了

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

至此，xml版的也完成了，打开浏览器，输入路径，就能看到结果了。

5、总结
总体而言，注解版更简洁也更清晰，是推荐使用的。关于springboot，网上有很多的教程，但基本上要么说的不清楚，有些干脆有问题，想看源码吧，没有。很多时候，一个小问题就能成为初学者的拦路虎，因此笔者尽可能地说明曾遇到的每一个问题，当然仍会有不足之处，欢迎留言交流。初学，源码是必看的。
注解版源码
xml版源码
---------------------

原文：https://blog.csdn.net/qq_41690306/article/details/79304506