MyBatis 是一款优秀的持久层框架,被各大互联网公司使用,本文使用Spring Boot整合Mybatis,并完成CRUD操作。
为什么要使用Mybatis?我们需要掌握Mybatis吗?
说的官方一点:
MyBatis 是一款优秀的持久层框架,它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以使用简单的 XML 或注解来配置和映射原生信息,将接口和 Java 的 POJOs(Plain Ordinary Java Object,普通的 Java对象)映射成数据库中的记录。
说的功利一点:
据说目前各大互联网公司通常使用Mybatis,还不赶快学习一下吗?
怎么使用?
这才是本文的重点。
新建Spring Boot工程和导入Eclipse这些在这里就不啰嗦了,不会的可以查看只需两步!Eclipse+Maven快速构建第一个Spring Boot项目。
1. pom.xml添加依赖
Spring Boot整合Mybatis需要引入 mybatis-spring-boot-starter;我使用的是MySQL数据库,需要引入ysql-connector-java。
mysql
mysql-connector-java
org.mybatis.spring.boot
mybatis-spring-boot-starter
1.1.1
2. application.property配置Mybatis和数据源
mybatis.config-location=classpath:mapper/mybatis_config.xml
mybatis.mapper-locations=classpath:mapper/*Mapper.xml
mybatis.type-aliases-package=com.shangguan.mybatis.entity
spring.datasource.driverClassName = com.mysql.cj.jdbc.Driver
spring.datasource.url = jdbc:mysql://localhost:3306/spring_boot?serverTimezone=GMT%2B8
spring.datasource.username = root
spring.datasource.password = 123456
例如我的mybatis_config.xml的路径为/mybatis/src/main/resources/mapper/mybatis_config.xml(下面是目录结构图),那么我的mybatis.config-location配置为classpath:mapper/mybatis_config.xml,请注意一定要根据自己项目的目录结构进行配置Mybatis。数据库也一样。
mapper包里面是Mybatis的映射类。
interceptor包是拦截器,如果还有疑问请参考之前的博文:Spring Boot配置拦截器及实现跨域访问
3. Mybatis全局配置文件
MyBatis 的配置文件包含了会深深影响 MyBatis 行为的设置(settings)和属性(properties)信息。关于配置文件的详解请看 xml映射配置文件。
mybatis_config.xml
4. 实体类User
User使用的和之前使用的一样,没有修改。
User:
public class User implements Serializable { private static final long serialVersionUID = 1L; private Long id; private String userName; private String passWord; public User() { super();
} public User(String userName, String passWord) { super(); this.userName = userName; this.passWord = passWord;
} public Long getId() { return id;
} public void setId(Long id) { this.id = id;
} public String getUserName() { return userName;
} public void setUserName(String userName) { this.userName = userName;
} public String getPassWord() { return passWord;
} public void setPassWord(String passWord) { this.passWord = passWord;
}
@Override public String toString() { return "userName " + this.userName + ", pasword " + this.passWord;
}
}
5. 添加User的映射文件和映射类
SQL 映射文件有很少的几个顶级元素(按照它们应该被定义的顺序):
cache – 给定命名空间的缓存配置。
cache-ref – 其他命名空间缓存配置的引用。
resultMap – 是最复杂也是最强大的元素,用来描述如何从数据库结果集中来加载对象。
parameterMap – 已废弃!老式风格的参数映射。内联参数是首选,这个元素可能在将来被移除,这里不会记录。
sql – 可被其他语句引用的可重用语句块。
insert – 映射插入语句
update – 映射更新语句
delete – 映射删除语句
select – 映射查询语句
更多信息请参考 xml映射文件 。
增删改查的SQL语句在UserMapper.xml里面书写,具体的看代码,里面有注释。
有几点需要注意的地方:
①
②当SQL语句中有多个参数的时候,需要在映射类方法里面加@Param的注解,不然会抛出异常说找不到参数。例如:
public void updateUser(@Param("id") Long id, @Param("userName") String userName,
@Param("passWord") String passWord);
③主键自增,需要设置useGeneratedKeys="true" keyProperty="id"
UserMapper.xml:
insert into user(username,password) values(#{userName},#{passWord})
delete from user where id =#{id}
update user set userName = #{userName},passWord = #{passWord}
where id = #{id}
映射类UserMapper.java:
@Mapper
public interface UserMapper {
public List getAll();
public void saveUser(User user);
public void deleteUserById(Long id);
public void updateUser(@Param("id") Long id, @Param("userName") String userName,
@Param("passWord") String passWord);
}
6. Service层实现
UserService里面有四个方法:增删改查。查询所有的用户,保存用户,通过id删除用户,更新用户信息。
UserService:
public interface UserService {
public List getAllUser();
public void saveUser(User user);
public void deleteUserById(Long id);
public void updateUser(Long id, String userName, String passWord);
}
UserServiceImpl:
@Service
public class UserServiceImpl implements UserService {
@Autowired private UserMapper userMapper;
@Override public List getAllUser() {
List list = userMapper.getAll(); return list;
}
@Override public void saveUser(User user) {
userMapper.saveUser(user);
}
@Override public void deleteUserById(Long id) {
userMapper.deleteUserById(id);
}
@Override public void updateUser(Long id, String userName, String passWord) {
userMapper.updateUser(id, userName, passWord);
}
}
7. Controller层实现
UserController里面对接口进行封装:
@RestController
@SpringBootApplication
@RequestMapping("/mybatis") public class UserController {
@Autowired private UserService userService;
@RequestMapping("/getAllUser") public List getAllUser() {
List list = userService.getAllUser(); return list;
}
@RequestMapping("/saveUser") public void saveUser(User user) {
userService.saveUser(user);
}
@RequestMapping("/deleteUserById") public void deleteUserById(Long id) {
userService.deleteUserById(id);
}
@RequestMapping("/updateUser") public void updateUser(Long id, String userName, String passWord) {
userService.updateUser(id, userName, passWord);
}
}
8. 测试
启动Spring Boot项目,使用Postman进行测试:
① http://localhost:8080/mybatis/getAllUser 获取所有的用户信息
对比数据库无误:
② http://localhost:8080/mybatis/saveUser?userName=啊哈&passWord=123321 添加一个名字为啊哈,密码为123321的用户
添加成功:
③ http://localhost:8080/mybatis/deleteUserById?id=6 删除id为6的用户
删除成功:
④ http://localhost:8080/mybatis/updateUser?id=7&userName=三只松鼠&passWord=three 设置id为7的用户的用户名和密码
设置成功:
总结
许多事情总是看起来简单做起来难,看着网上的Spring Boot整合教程觉得太简单了,自己动手实践的过程中依然会发现有一些需要注意的细节。
完整代码:GitHub地址
参考:spring boot(六):如何优雅的使用mybatis