目录
MyBatis是基于JDBC的一个工具框架,能够更好帮助程序与数据库进行交互,也能更方便的进行数据库中数据的存储与读取.
MyBatis是一个ORM(Object Relational Mapping)框架,ORM即是对象关系映射.在编程语言中,将关系型数据库中的数据与对象建立映射关系,更方便的完成数据与对象间的转换.
一般的ORM映射关系:
在加入了Mybatis的项目中,一般会为一张表创建一个类并进行映射,就使得像平常操作对象一般操作数据库中的数据.
在项目中添加Mysql数据库与MyBatis相关的框架.
如果是老的项目可以使用EditStarters插件进行添加
在项目的配置文件中对数据库的连接进行配置,此处使用的是yml类型的配置文件.主要是作用是将项目与数据库能够进行连接.
记得对URL中的目标数据库进行修改.
- spring:
- datasource:
- url: jdbc:mysql://localhost:3306/test1?characterEncoding=utf8&useSSL=false #连接数据库的地址
- username: root #数据库的用户名
- password: #数据库的密码
- driver-class-name: com.mysql.cj.jdbc.Driver
将上述代码放置到yml配置文件中
注意事项 :
检查mysql-connector-java的版本号,如果是 5.x 之前的使⽤的“com.mysql.jdbc.Driver”,如果是⼤于 5.x使⽤的是“com.mysql.cj.jdbc.Driver”
在resources的目录下创建一个目录(此处我命名为mybatis).
并在项目的配置文件中将刚刚创建的目录添加到mybatis的xml路径
最终配置文件大致为:
一般的业务的后端开发思路为:
我们只要跟着上面的开发思路来写代码就好了.
注意:
下面所创建的所有类都要跟启动类放到同一个文件夹之中.
创建实体类
映射到一个数据库中的表.
- @Data
- public class User {
- private String name;
- private int age;
- private int id;
- private String sex;
- }
创建Serveric类
- @Service
- public class UserService {
- @Autowired
- UserMapper userMapper;
-
- public User getUserByName(String name){
- return userMapper.getUserByName(name);
- }
- }
创建Controller类
- @Controller
- public class UserController{
- @Autowired
- UserService userService;
-
- public User getUserByName(String name){
- return userService.getUserByName(name);
- }
- }
创建Mapper
Mapper的组成为接口+XML
- @Mapper
- public interface UserMapper {
- User getUserByName(@Param("name") String name);
- //使用Param注解,将接口方法中的参数设置成为xml中传输的参数(不写也可以,写了更严谨可以尽量避免出现bug)
- }
在之前的配置文件中配置mybatis的xml的目录中创建一个对应的xml
(将下面的代码拷贝,更改对应的mapper标签中的namespace.在mapper标签中写上对应的sql语句)
- "1.0" encoding="UTF-8"?>
- mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybati
- s.org/dtd/mybatis-3-mapper.dtd">
- <mapper namespace="com.example.demo.Mapper.UserMapper">
-
- mapper>
mapper标签中需要指定namespace属性,表示命名空间,为mapper接口的全限定名(包名+类名)去指定一个mapper.
对应表的创建语句:
- create table Users(name varchar(15),
- age int,
- id int primary key auto_increment,
- sex varchar(6));
在MyBatis中的SQL语句都在XML文件中搭配对应的标签来实现.
可以在SpringBoot项目的配置文件中设置Mapper类的日志等级为debug,这样就可以在控制台中查看数据库操作的预处理语句,参数和受影响的行数了.
(此处为yml类型配置文件的语句)
- mybatis:
- mapper-locations: classpath:mybatis/*Mapper.xml
- configuration:
- log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
-
- logging:
- level:
- com.example.demo.Mapper: debug //此处是类的路径 + 日志的等级
增加操作使用
controller类
- @ResponseBody//记得添上@ResponseBody,表明返回的是一个数据而不是页面
- @PostMapping("/add")//POST由客户端上传数据至服务器
- public Integer add(@RequestBody User user){//@RequestBody标签将方法中的user参数获取请求body中的json格式
- return userService.add(user);
- }
Service类
- public Integer add(User user){
- return userMapper.add(user);
- }
Mapper
最好要使用Integer做返回值噢
- //增加操作,返回受影响的行数
- //返回类型为Integer而不是int,是因为int的默认值为0,Integer的默认值为null
- //使用int就不知道语句是否对数据库造成了影响,
- //Integer可以区分未赋值与受影响行数为0的区别
- Integer add(User user);
xml
- "1.0" encoding="UTF-8"?>
- mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybati
- s.org/dtd/mybatis-3-mapper.dtd">
- <mapper namespace="com.example.demo.Mapper.UserMapper">
-
- <insert id="add">
- insert into Users(name,age,sex) values(#{name},#{age},#{sex});
-
- insert>
- mapper>
可以看到返回值为受影响的行数.
返回受影响的行数据的主键
当我们在某些情况下想要获取对应的主键,可以在insert标签上进行设置.
useGeneratedKeys : 使用主键,默认值为false,
keyProperty : 主键的属性名为(实体类中的属性)
- <insert id="add" useGeneratedKeys="true" keyProperty="id">
- insert into Users(name,age,sex) values(#{name},#{age},#{sex});
-
- insert>
然后我们就可以直接在方法中使用对象的主键属性了,先前都是默认自增值没有对其进行赋值,
- @ResponseBody//记得添上@ResponseBody,表明返回的是一个数据而不是页面
- @PostMapping("/add")//POST由客户端上传数据至服务器
- public Integer add(@RequestBody User user){//@RequestBody标签将方法中的user参数获取请求body中的json格式
- Integer ret = userService.add(user);
- System.out.println("UserID为:" + user.getId());
- return ret;
- }
使用
由于Controller类与Service类都大差不大就不展示啦.
Mapper
Integer update(User user);
- <update id="update">
- update Users set age = #{age} where name = #{name};
- update>
删除操作使用
Mapper
Integer delete(User user);
- <delete id="delete">
- delete from Users where id = #{id};
- delete>
在上述的增加,删除以及修改操作中,一般的默认的返回值为受影响的行数.但其实可以不使用映射来接收这个参数的.
但对于查询操作来说,不得不接收返回的参数,不然会进行报错.
而在MyBatis中,实现结果映射的标签一共有两种
此标签能够适用于绝大多数的场景,其中resultType表明要返回的类型.
可以是一个类,也可以的基本类型或引用类型.
其中的resultType值可以为类名,或"string"或"java.lang.String"或"int"或"java.lang.Integer"...
- select name from Users where id = #{id};
因为
将Controller类的标签更改为get方法,并使用表单传输信息.
User getNameById(@Param("id") Integer id);
- <select id="getNameById" resultType="com.example.demo.model.User">
- select name from Users where id = #{id};
- select>
使用多表查询获取一对多,使用List来接收多个对象.但注意xml中的返回类型是单个对象的类型
Mapper
List get(String name);
XML
- <select id="get" resultType="com.example.demo.model.VO.BookVO">
- select title,author_id,name from books left join Users on books.author_id = Users.id where Users.name = #{name};
- select>
因为使用#{}会进行预处理编译,会把数据自动的加上单引号 zhangsan -> 'zhangsan'
如果直接使用模糊查询, like '%#{name}%' 就会变成 -> like '%'name'%' 显然是错误的,但如果使用${}字符串替换又会有sql注入的风险,
所以我们可以使用concat方法对%与参数进行连接.
- <select id="getByName" resultType="com.example.demo.model.User">
- select * from Users where name like concat('%',#{name},'%');
- select>
我们之前可能在遇到过,填写个人信息表单的时候会出现非必填项.
此处就可以使用
当我们填写name,age却不想写填写sex的时候,就可以使用
Mapper:
Integer add2(User user);
XML:
- <insert id="add2">
- insert into Users(name,age<if test="sex != null">,sexif>) values(#{name},#{age}<if test="sex != null">,#{sex}if>);
- insert>
其中
如果传输的user对象中sex属性为空,则不填写
对应的,因为
上面的例子为单个非必填选项,那如果我每一个都是非必填呢?
因为SQL语句中字段间的分隔需要逗号来实现,所以单单依靠于
- <insert id="add2">
- insert into Users
- <trim prefix="(" suffix=")" suffixOverrides=",">
- <if test="name != null">name,if>
- <if test="age != null">age,if>
- <if test="sex != null">sex,if>
- trim>
- <trim prefix="values (" suffix=")" suffixOverrides=",">
- <if test="name != null">#{name},if>
- <if test="age != null">#{age},if>
- <if test="sex != null">#{sex},if>
- trim>
- insert>
在使用
其中还有这两个标签,其实这两个标签都是
对集合进⾏遍历时可以使⽤该标签。
- <delete id="deleteByIds">
- delete from article
- where id in
- <foreach collection="list" item="item" open="(" close=")" separator=",">
- #{item}
- foreach>
- delete>
就像java里的foreach遍历一样.
传输数组进行调试
预处理后的样子:
TIPS:
在后端类的属性与数据库中字段名不相同时,可以在SQL语句中使用as为字段起别名
- <select id="getId" resultType="com.example.demo.model.Book">
- select author_id as authorID,title,content from books where title = #{title};
- select>