mybatis,mybatis 官网
这篇文章给大家聊聊关于mybatis,以及mybatis 官网对应的知识点,希望对各位有所帮助,不要忘了收藏本站哦。
如何优雅的使用mybatis
如何优雅的使用mybatis
这两天启动了一个新项目因为项目组成员一直都使用的是mybatis,虽然个人比较喜欢jpa这种极简的模式,但是为了项目保持统一性技术选型还是定了 mybatis。到网上找了一下关于spring boot和mybatis组合的相关资料,各种各样的形式都有,看的人心累,结合了mybatis的官方demo和文档终于找到了最简的两种模式,花了一天时间总结后分享出来。
orm框架的本质是简化编程中操作数据库的编码,发展到现在基本上就剩两家了,一个是宣称可以不用写一句SQL的hibernate,一个是可以灵活调试动态sql的mybatis,两者各有特点,在企业级系统开发中可以根据需求灵活使用。发现一个有趣的现象:传统企业大都喜欢使用hibernate,互联网行业通常使用mybatis。
hibernate特点就是所有的sql都用Java代码来生成,不用跳出程序去写(看)sql,有着编程的完整性,发展到最顶端就是spring data jpa这种模式了,基本上根据方法名就可以生成对应的sql了,有不太了解的可以看我的上篇文章springboot(五):spring data jpa的使用。
mybatis初期使用比较麻烦,需要各种配置文件、实体类、dao层映射关联、还有一大推其它配置。当然mybatis也发现了这种弊端,初期开发了generator可以根据表结果自动生产实体类、配置文件和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>1234512345
好了下来分别介绍两种开发模式
无配置文件注解版
就是一切使用注解搞定。
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>12345678910111213141516171819202122232425262728291234567891011121314151617181920212223242526272829
完整的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= root123456123456
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);
}
}1234567812345678
或者直接在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);
}12345678910111213141516171819202122232425261234567891011121314151617181920212223242526
为了更接近生产我特地将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);12345671234567
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())));
}
}1234567891011121314151617181920212223242526272829303112345678910111213141516171819202122232425262728293031
源码中controler层有完整的增删改查,这里就不贴了
源码在这里spring-boot-mybatis-annotation
极简xml版本
极简xml版本保持映射文件的老传统,优化主要体现在不需要实现dao的是实现层,系统会自动根据方法名在映射文件中找对应的sql.
1、配置
pom文件和上个版本一样,只是application.properties新增以下配置
mybatis.config-locations=classpath:mybatis/mybatis-config.xml
mybatis.mapper-locations=classpath:mybatis/mapper/*.xml1212
指定了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>1234567891012345678910
这里也可以添加一些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>1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515212345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
其实就是把上个版本中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);
}1234567891011121312345678910111213
对比上一步这里全部只剩了接口方法
4、使用
使用和上个版本没有任何区别,大家就看代码吧
xml配置版本
如何选择
两种模式各有特点,注解版适合简单快速的模式,其实像现在流行的这种微服务模式,一个微服务就会对应一个自已的数据库,多表连接查询的需求会大大的降低,会越来越适合这种模式。
老传统模式比适合大型项目,可以灵活的动态生成SQL,方便调整SQL,也有痛痛快快,洋洋洒洒的写SQL的感觉。
mybatis基本配置详解
中间步骤自行设置
MySQL驱动版本根据自己安装的MySQL选择
我把AppTest改成了MybatisTest,不该也无妨;
其中Student类暂时只设置四个字段:
mapper接口暂时为空
在resources目录下新建File命名为db.peoperties,配置如下内容:
提示:以上配置适用于MySQL8.X版本,5.X版本按照如下配置:
1、transactionManager:事务管理器;
type事务管理类型:
JDBC(JdbcTransactionFactory);
MANAGED(ManagedTransactionFactory)
自定义事务管理器:实现TransactionFactory接口.type指定为全类名
2、dataSource:数据源;
type:数据源类型;
UNPOOLED(UnpooledDataSourceFactory); POOLED(PooledDataSourceFactory);
JNDI(JndiDataSourceFactory)
自定义数据源:实现DataSourceFactory接口,type是全类名
<mapper>:注册一个sql映射文件
1、注册映射文件
resource:引用类路径下的sql映射文件
mybatis/StudentMapperpper.xml
url:引用网路路径或者磁盘路径下的sql映射文件
2、注册接口
class:引用(注册)接口,
①有sql映射文件,映射文件名必须和接口同名,并且放在与接口同一目录下;
②没有sql映射文件,所有的sql都是利用注解写在接口上;
推荐:
比较重要的,复杂的Dao接口我们来写sql映射文件
不重要,简单的Dao接口为了开发快速可以使用注解;
批量注册
需要在资源路径下(resources)建立和dao一样的文件目录来存放想xml映射文件,如:com.example.StudentMapperpper.xml
StudentMapper
在resources的mybatis目录下新建文件夹mapper,新建xml文件StudentMapper.xml
namespace:名称空间;指定为接口的全类名
id:唯一标识
resultType:返回值类型
#{id}:从传递过来的参数中取出id值
resources目录(MajorMapper.xml暂时不用创建)如下:
mybatis原理
MyBatis的工作原理:读取 MyBatis配置文件、加载映射文件、构造会话工厂、创建会话对象、Executor执行器、输入参数映射、输出结果映射。
mybatis原理具体介绍如下:
1、读取 MyBatis配置文件:
mybatis-config.xml为 MyBatis的全局配置文件,配置了 MyBatis的运行环境等信息,例如数据库连接信息。
2、加载映射文件:
映射文件即 SQL映射文件,该文件中配置了操作数据库的 SQL语句,需要在 MyBatis配置文件 mybatis-config.xml中加载。mybatis-config.xml文件可以加载多个映射文件,每个文件对应数据库中的一张表。
3、构造会话工厂:
通过 MyBatis的环境等配置信息构建会话工厂 SqlSessionFactory。
4、创建会话对象:
由会话工厂创建 SqlSession对象,该对象中包含了执行 SQL语句的所有方法。
5、Executor执行器:
MyBatis底层定义了一个 Executor接口来操作数据库,它将根据 SqlSession传递的参数动态地生成需要执行的 SQL语句,同时负责查询缓存的维护。
6、MappedStatement对象:
在 Executor接口的执行方法中有一个 MappedStatement类型的参数,该参数是对映射信息的封装,用于存储要映射的 SQL语句的 id、参数等信息。
7、输入参数映射:
输入参数类型可以是 Map、List等集合类型,也可以是基本数据类型和 POJO类型。输入参数映射过程类似于 JDBC对 preparedStatement对象设置参数的过程。
8、输出结果映射:
输出结果类型可以是 Map、 List等集合类型,也可以是基本数据类型和 POJO类型。输出结果映射过程类似于 JDBC对结果集的解析过程。
关于mybatis到此分享完毕,希望能帮助到您。