欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

深入理解SpringBoot中关于Mybatis使用方法

程序员文章站 2022-06-21 15:58:29
这两天启动了一个新项目因为项目组成员一直都使用的是mybatis,虽然个人比较喜欢jpa这种极简的模式,但是为了项目保持统一性技术选型还是定了 mybatis。到网上找了一...

这两天启动了一个新项目因为项目组成员一直都使用的是mybatis,虽然个人比较喜欢jpa这种极简的模式,但是为了项目保持统一性技术选型还是定了 mybatis。到网上找了一下关于spring boot和mybatis组合的相关资料,各种各样的形式都有,看的人心累,结合了mybatis的官方demo和文档终于找到了最简的两种模式,花了一天时间总结后分享出来。

orm框架的本质是简化编程中操作数据库的编码,发展到现在基本上就剩两家了,一个是宣称可以不用写一句sql的hibernate,一个是可以灵活调试动态sql的mybatis,两者各有特点,在企业级系统开发中可以根据需求灵活使用。发现一个有趣的现象:传统企业大都喜欢使用hibernate,互联网行业通常使用mybatis。

hibernate特点就是所有的sql都用java代码来生成,不用跳出程序去写(看)sql,有着编程的完整性,发展到最顶端就是spring data jpa这种模式了,基本上根据方法名就可以生成对应的sql了,有不太了解的可以看我的上篇文章。

mybatis初期使用比较麻烦,需要各种配置文件、实体类、dao层映射关联、还有一大推其它配置。当然mybatis也发现了这种弊端,初期开发了可以根据表结果自动生产实体类、配置文件和dao层代码,可以减轻一部分开发量;后期也进行了大量的优化可以使用注解了,自动管理dao层和配置文件等,发展到最顶端就是今天要讲的这种模式了,mybatis-spring-boot-starter就是springboot+mybatis可以完全注解不用配置文件,也可以简单配置轻松上手。

现在想想spring boot 就是牛逼呀,任何东西只要关联到spring boot都是化繁为简。

mybatis-spring-boot-starter

官方说明:mybatis spring-boot-starter will help you use mybatis with spring boot
其实就是mybatis看spring boot这么火热也开发出一套解决方案来凑凑热闹,但这一凑确实解决了很多问题,使用起来确实顺畅了许多。mybatis-spring-boot-starter主要有两种解决方案,一种是使用注解解决一切问题,一种是简化后的老传统。

当然任何模式都需要首先引入mybatis-spring-boot-starter的pom文件,现在最新版本是1.1.1(刚好快到双11了 :))

<dependency>
<groupid>org.mybatis.spring.boot</groupid>
<artifactid>mybatis-spring-boot-starter</artifactid>
<version>1.1.1</version>
</dependency>

好了下来分别介绍两种开发模式

无配置文件注解版

就是一切使用注解搞定。

1 添加相关maven文件

<dependencies>
<dependency>
<groupid>org.springframework.boot</groupid>
<artifactid>spring-boot-starter</artifactid>
</dependency>
<dependency>
<groupid>org.springframework.boot</groupid>
<artifactid>spring-boot-starter-test</artifactid>
<scope>test</scope>
</dependency>
<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.1.1</version>
</dependency>
<dependency>
<groupid>mysql</groupid>
<artifactid>mysql-connector-java</artifactid>
</dependency>
<dependency>
<groupid>org.springframework.boot</groupid>
<artifactid>spring-boot-devtools</artifactid>
<optional>true</optional>
</dependency>
</dependencies>

完整的pom包这里就不贴了,大家直接看源码

2、application.properties 添加相关配置

mybatis.type-aliases-package=com.neo.entity

spring.datasource.driverclassname = com.mysql.jdbc.driver
spring.datasource.url = jdbc:mysql://localhost:3306/test1?useunicode=true&characterencoding=utf-8
spring.datasource.username = root
spring.datasource.password = root

springboot会自动加载spring.datasource.*相关配置,数据源就会自动注入到sqlsessionfactory中,sqlsessionfactory会自动注入到mapper中,对了你一切都不用管了,直接拿起来使用就行了。

在启动类中添加对mapper包扫描@mapperscan

@springbootapplication
@mapperscan("com.neo.mapper")
public class application {

public static void main(string[] args) {
springapplication.run(application.class, args);
}
}

或者直接在mapper类上面添加注解@mapper,建议使用上面那种,不然每个mapper加个注解也挺麻烦的

3、开发mapper

第三步是最关键的一块,sql生产都在这里

public interface usermapper {

@select("select * from users")
@results({
@result(property = "usersex", column = "user_sex", javatype = usersexenum.class),
@result(property = "nickname", column = "nick_name")
})
list<userentity> getall();

@select("select * from users where id = #{id}")
@results({
@result(property = "usersex", column = "user_sex", javatype = usersexenum.class),
@result(property = "nickname", column = "nick_name")
})
userentity getone(long id);

@insert("insert into users(username,password,user_sex) values(#{username}, #{password}, #{usersex})")
void insert(userentity user);

@update("update users set username=#{username},nick_name=#{nickname} where id =#{id}")
void update(userentity user);

@delete("delete from users where id =#{id}")
void delete(long id);

}

为了更接近生产我特地将user_sex、nick_name两个属性在数据库加了下划线和实体类属性名不一致,另外user_sex使用了枚举

@select 是查询类的注解,所有的查询均使用这个
@result 修饰返回的结果集,关联实体类属性和数据库字段一一对应,如果实体类属性和数据库属性名保持一致,就不需要这个属性来修饰。
@insert 插入数据库使用,直接传入实体类会自动解析属性到对应的值
@update 负责修改,也可以直接传入对象
@delete 负责删除

了解更多属性参考这里: 

注意,使用#符号和$符号的不同:

// this example creates a prepared statement, something like select * from teacher where name = ?;
@select("select * from teacher where name = #{name}")
teacher selectteachforgivenname(@param("name") string name);

// this example creates n inlined statement, something like select * from teacher where name = 'somename';
@select("select * from teacher where name = '${name}'")
teacher selectteachforgivenname(@param("name") string name);

4、使用

上面三步就基本完成了相关dao层开发,使用的时候当作普通的类注入进入就可以了

@runwith(springrunner.class)
@springboottest
public class usermappertest {

@autowired
private usermapper usermapper;

@test
public void testinsert() throws exception {
usermapper.insert(new userentity("aa", "a123456", usersexenum.man));
usermapper.insert(new userentity("bb", "b123456", usersexenum.woman));
usermapper.insert(new userentity("cc", "b123456", usersexenum.woman));

assert.assertequals(3, usermapper.getall().size());
}

@test
public void testquery() throws exception {
list<userentity> users = usermapper.getall();
system.out.println(users.tostring());
}

@test
public void testupdate() throws exception {
userentity user = usermapper.getone(3l);
system.out.println(user.tostring());
user.setnickname("neo");
usermapper.update(user);
assert.asserttrue(("neo".equals(usermapper.getone(3l).getnickname())));
}
}

源码中controler层有完整的增删改查,这里就不贴了

极简xml版本

极简xml版本保持映射文件的老传统,优化主要体现在不需要实现dao的是实现层,系统会自动根据方法名在映射文件中找对应的sql.

1、配置

pom文件和上个版本一样,只是application.properties新增以下配置

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

指定了mybatis基础配置文件和实体类映射文件的地址

mybatis-config.xml 配置

<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>

这里也可以添加一些mybatis基础的配置

2、添加user的映射文件

<mapper namespace="com.neo.mapper.usermapper" >
<resultmap id="baseresultmap" type="com.neo.entity.userentity" >
<id column="id" property="id" jdbctype="bigint" />
<result column="username" property="username" jdbctype="varchar" />
<result column="password" property="password" jdbctype="varchar" />
<result column="user_sex" property="usersex" javatype="com.neo.enums.usersexenum"/>
<result column="nick_name" property="nickname" jdbctype="varchar" />
</resultmap>

<sql id="base_column_list" >
id, username, password, user_sex, nick_name
</sql>

<select id="getall" resultmap="baseresultmap" >
select 
<include refid="base_column_list" />
from users
</select>

<select id="getone" parametertype="java.lang.long" resultmap="baseresultmap" >
select 
<include refid="base_column_list" />
from users
where id = #{id}
</select>

<insert id="insert" parametertype="com.neo.entity.userentity" >
insert into 
users
(username,password,user_sex) 
values
(#{username}, #{password}, #{usersex})
</insert>

<update id="update" parametertype="com.neo.entity.userentity" >
update 
users 
set 
<if test="username != null">username = #{username},</if>
<if test="password != null">password = #{password},</if>
nick_name = #{nickname}
where 
id = #{id}
</update>

<delete id="delete" parametertype="java.lang.long" >
delete from
users 
where 
id =#{id}
</delete>
</mapper>

其实就是把上个版本中mapper的sql搬到了这里的xml中了

3、编写dao层的代码

public interface usermapper {

list<userentity> getall();

userentity getone(long id);

void insert(userentity user);

void update(userentity user);

void delete(long id);

}

对比上一步这里全部只剩了接口方法

4、使用

使用和上个版本没有任何区别,大家就看代码吧

如何选择

两种模式各有特点,注解版适合简单快速的模式,其实像现在流行的这种微服务模式,一个微服务就会对应一个自已的数据库,多表连接查询的需求会大大的降低,会越来越适合这种模式。

老传统模式比适合大型项目,可以灵活的动态生成sql,方便调整sql,也有痛痛快快,洋洋洒洒的写sql的感觉。

示例代码-github: 

示例代码-码云: