一千个读者有一千个哈姆雷特。
你们的项目中,倾向于把数据库的语句写在Java类里,还是使用Mybatis框架呢?
相对来说,做一些复杂的大项目,用第三方开源的Mybatis会比较好。把数据库操作语句抽取出来,写在xml文件,方便管理。
个人比较倾向于使用Mybatis,还有Mybatis的逆向工程,听说很好使,但本人还没用过,后续会加上博客,敬请期待吧!
项目结构,标注的是新增的文件:
本篇博客接着上一篇,在 pom.xml 里添加 Mybatis 的jar依赖:
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.3.1</version>
</dependency>
在 resources 文件夹下创建 mybatis-config.xml 配置文件,与application.properties同一级:
<?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>
<!-- 全局配置参数 -->
<settings>
<!-- 使全局的映射器启用或禁用缓存。 -->
<setting name="cacheEnabled" value="true"/>
<!-- debug 模式打印 sql 语句 -->
<setting name="logImpl" value="STDOUT_LOGGING"/>
</settings>
</configuration>
接口 UserDao,注意需要添加 @Mapper 注解,否则无法调用Mybatis框架:
或者在启动的类加上:@MapperScan("com.test.dao") 注解,扫描的是Dao层的包。这样就不需要在每个 Dao 类里加入注解@Mapper 了。
package com.test.dao;
import com.test.entity.User;
import org.apache.ibatis.annotations.Mapper;
import java.util.List;
@Mapper
public interface UserDao {
/**
* 新增用户
* @param user
* @return
*/
Integer addUserMybatis(User user);
/**
* 根据id删除用户
* @param id
* @return
*/
Integer deleteUserMybatis(Integer id);
/**
* 更新用户信息
* @param user
* @return
*/
Integer updateUserMybatis(User user);
/**
* 查询所有用户信息
* @return
*/
List<User> getUserMybatis();
}
业务层,UserServiceMybatis(为了和之前的UserService做区分):
package com.test.service;
import com.test.dao.UserDao;
import com.test.entity.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
import java.util.List;
@Service
public class UserServiceMybatis {
@Autowired
private UserDao userDao;
/**
* 新增用户
* @param user
* @return
*/
@Transactional(readOnly = false)
public Integer addUserMybatis(User user){
return userDao.addUserMybatis(user);
}
/**
* 根据id删除用户
* @param id
* @return
*/
@Transactional(readOnly = false)
public Integer deleteUserMybatis(Integer id){
return userDao.deleteUserMybatis(id);
}
/**
* 更新用户信息
* @param user
* @return
*/
@Transactional(readOnly = false)
public Integer updateUserMybatis(User user){
return userDao.updateUserMybatis(user);
}
/**
* 查询所有用户信息
* @return
*/
@Transactional(readOnly = true)
public List<User> getUserMybatis(){
return userDao.getUserMybatis();
}
}
说明:可以看到我使用了事务注解 @Transactional(readOnly = true),@Transactional(readOnly = false),在一些增、删、改、调用存储过程的方法中,需要把 readOnly 设置为 false,默认的是false,可以不添加。以后的开发中,在一些关键的查询操作,可以指定 readOnly 属性。
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.test.dao.UserDao">
<!-- 数据库字段与实体类字段的映射,column是数据库的列名,property是实体类的属性名 -->
<resultMap id="UserBaseResultMap" type="com.test.entity.User">
<id column="id" jdbcType="INTEGER" property="id"/>
<result column="name" jdbcType="VARCHAR" property="name"/>
<result column="signature" jdbcType="VARCHAR" property="signature"/>
</resultMap>
<!-- 新增用户,id就是方法名 -->
<insert id="addUserMybatis">
insert into t_user (name,signature) values (#{name},#{signature})
</insert>
<!-- 删除用户,id就是方法名,parameterType可以写,也可以不写。 -->
<delete id="deleteUserMybatis" parameterType="java.lang.Integer">
delete from t_user where id = #{id,jdbcType=INTEGER}
</delete>
<!-- 修改用户 -->
<update id="updateUserMybatis">
update t_user set name = #{name},signature =#{signature} where id = #{id}
</update>
<!-- 查询所有用户,将结果映射到 UserBaseResultMap 对应的属性中,如果有多个结果集,会返回多个实体类 -->
<select id="getUserMybatis" resultMap="UserBaseResultMap">
select * from t_user
</select>
</mapper>
需要注意的是:①mapper namespace="com.test.dao.UserDao"
②诸如 select、insert、update的id,对应的是Dao层的方法名。配置文件的 id 是不允许重复的,意思就是说,在 Dao 层里,不允许方法重载。
想学习更多关于Mybatis的知识,可以去Mybatis中文官网学习。
MybatisController,注意,在类的签名里使用了 @RestController 的注解,默认的返回 Json 格式数据。
package com.test.web;
import com.test.entity.User;
import com.test.service.UserServiceMybatis;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
@RestController
public class MybatisController {
@Autowired
private UserServiceMybatis userServiceMybatis;
/**
* 新增用户
* @param name
* @param signature
* @return
*/
@RequestMapping(value = "/addUserMybatis")
public Map<String,Integer> addUserMybatis(@RequestParam String name, @RequestParam String signature){
User u=new User();
u.setName(name);
u.setSignature(signature);
Integer count = userServiceMybatis.addUserMybatis(u);
Map<String, Integer> map = new HashMap<>();
map.put("count", count);
return map;
}
/**
* 根据id删除用户信息
* @param id
* @return
*/
@RequestMapping(value = "/deleteUserMybatis")
public Map<String,Integer> deleteUserMybatis(@RequestParam Integer id){
Integer count = userServiceMybatis.deleteUserMybatis(id);
Map<String, Integer> map = new HashMap<>();
map.put("count", count);
return map;
}
/**
* 更新用户信息
* @param id
* @param name
* @param signature
* @return
*/
@RequestMapping(value = "/updateUserMybatis")
public Map<String,Integer> updateUserMybatis(@RequestParam Integer id,@RequestParam String name, @RequestParam String signature){
User u=new User();
u.setId(id);
u.setName(name);
u.setSignature(signature);
Integer count = userServiceMybatis.updateUserMybatis(u);
Map<String, Integer> map = new HashMap<>();
map.put("count", count);
return map;
}
/**
* 查询所有用户信息
* @return
*/
@RequestMapping(value = "/getUserMybatis")
public List<User> getUserMybatis(){
List<User> list = userServiceMybatis.getUserMybatis();
return list;
}
}
最关键的,application.properties 配置:
# 服务端口
server.port=9090
# 数据库连接配置
spring.datasource.url=jdbc:mysql://localhost:3306/mytest
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
# Mybatis配置
# Mybatis扫描的mapper文件
mybatis.mapperLocations=classpath:mappings/**/*.xml
# 扫描哪个包下的域对象
mybatis.typeAliasesPackage=com.test.entity
# Mybatis配置文件
mybatis.configLocation=classpath:mybatis-config.xml
# mybatis.typeAliasesSuperType 扫描包以下面的这个类作为父类的域对象
如果遇到下面类似的问题,就是因为 Mybatis 的配置没有完善
O的K,万事俱备只欠东风,用吊炸天的 postman 测试一下:
①测试新增用户,很OK:
去到编辑器的控制台查看打印的数据库语句:
Registering transaction synchronization for SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@7064da9b]
JDBC Connection [HikariProxyConnection@88415771 wrapping com.mysql.jdbc.JDBC4Connection@355db3e3] will be managed by Spring
==> Preparing: insert into t_user (name,signature) values (?,?)
==> Parameters: 小米(String), 为发烧而生(String)
<== Updates: 1
②查询所有用户:
③修改用户:
④删除用户:http://localhost:9090/deleteUserMybatis?id=2
完美整合Mybatis!
说明:其实也可以直接从 Controller 层调用 Dao 层,而不需要 Service 层,也是可以实现逻辑。加多一层 Service 能更好的增加权限控制、事务管理或者其它功能。