MyBatis(十四)mybatis的注解开发
目录
- Mybatis的注解开发
- 一、注解开发的环境搭建
- 创建一个新的项目
- 导入坐标
- 实体类User
- dao接口
- log4j的配置文件
- jdbcConfig.properties
- SqlMapConfig.xml文件
- 给`findAll()`方法添加注解
- 测试类测试
- · 注意事项
- 二、单表CRUD操作(代理Dao方式)
- 常用注解说明
- 保存用户的操作
- 更新用户的操作
- 删除用户
- 根据id查询用户信息
- 根据用户名称进行模糊查询
- 查询用户数量
- 用注解建立实体类和数据库列名的关系
- 三、复杂关系映射开发、多表操作
- 复杂关系映射的注解说明
- **`@Results`** 注解
- `@Resutl` 注解
- `@One`注解(一对一)
- `@Many`注解(多对一)
- 实现一对一复杂关系映射及延迟加载
- ① **User实体类 和 Account实体类**
- ② 持久层接口(使用注解配置)
- ③ 测试类
- 一对多的复杂关系映射
- ① `User`实体类中加入`List`
- ② 持久层接口配置
- ③ 测试方法:
- 四、缓存的配置
- 在SqlMapConfig.xml中开启二级缓存支持
- 在持久层接口中使用注解配置二级缓存
- 测试方法
Mybatis的注解开发
一、注解开发的环境搭建
1. 创建一个新的项目
2. 导入坐标
pom.xml文件:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.veeja</groupId>
<artifactId>day04_03mybatis</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<dependencies>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.5</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.6</version>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.12</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.10</version>
</dependency>
</dependencies>
</project>
3. 实体类User
package com.veeja.domain;
import java.io.Serializable;
import java.util.Date;
public class User implements Serializable {
private Integer id;
private String username;
private String address;
private String sex;
private Date birthday;
@Override
public String toString() {
return "User{" +
"id=" + id +
", username='" + username + '\'' +
", address='" + address + '\'' +
", sex='" + sex + '\'' +
", birthday=" + birthday +
'}';
}
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public String getAddress() {
return address;
}
public void setAddress(String address) {
this.address = address;
}
public String getSex() {
return sex;
}
public void setSex(String sex) {
this.sex = sex;
}
public Date getBirthday() {
return birthday;
}
public void setBirthday(Date birthday) {
this.birthday = birthday;
}
}
4. dao接口
package com.veeja.dao;
import com.veeja.domain.User;
import java.util.List;
/** * IUserDao接口 */
public interface IUserDao {
/** * 查询所有用户信息 * * @return */
List<User> findAll();
}
5. log4j的配置文件
src/main/resources下的log4j.properties:
# Set root category priority to INFO and its only appender to CONSOLE.
#log4j.rootCategory=INFO, CONSOLE debug info warn error fatal
log4j.rootCategory=debug, CONSOLE, LOGFILE
# Set the enterprise logger category to FATAL and its only appender to CONSOLE.
log4j.logger.org.apache.axis.enterprise=FATAL, CONSOLE
# CONSOLE is set to be a ConsoleAppender using a PatternLayout.
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.layout.ConversionPattern=%d{ISO8601} %-6r [%15.15t] %-5p %30.30c %x - %m\n
# LOGFILE is set to be a File appender using a PatternLayout.
log4j.appender.LOGFILE=org.apache.log4j.FileAppender
log4j.appender.LOGFILE.File=d:\axis.log
log4j.appender.LOGFILE.Append=true
log4j.appender.LOGFILE.layout=org.apache.log4j.PatternLayout
log4j.appender.LOGFILE.layout.ConversionPattern=%d{ISO8601} %-6r [%15.15t] %-5p %30.30c %x - %m\n
6. jdbcConfig.properties
src/main/resources下的jdbcConfig.properties:
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatisdatabase
jdbc.username=root
jdbc.password=0000
7. SqlMapConfig.xml文件
<?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>
<!--引入外部配置文件-->
<properties resource="jdbcConfig.properties"></properties>
<!--配置别名-->
<typeAliases>
<package name="com.veeja.domain"/>
</typeAliases>
<!--配置环境-->
<environments default="mysql">
<environment id="mysql">
<transactionManager type="JDBC"></transactionManager>
<dataSource type="POOLED">
<property name="driver" value="${jdbc.driver}"/>
<property name="url" value="${jdbc.url}"/>
<property name="username" value="${jdbc.username}"/>
<property name="password" value="${jdbc.password}"/>
</dataSource>
</environment>
</environments>
<!--引入带有注解的dao接口所在位置-->
<mappers>
<package name="com.veeja.dao"/>
</mappers>
</configuration>
这样我们的环境就算搭建完成了。接下来我们就要尝试使用注解的方式进行开发了。
8. 给findAll()
方法添加注解
/** * 查询所有用户信息 * * @return */
@Select("select * from user")
List<User> findAll();
9. 测试类测试
package com.veeja.test;
import com.veeja.dao.IUserDao;
import com.veeja.domain.User;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
public class UserTest {
/** * 测试基于注解的mybatis的使用 * * @param args */
public static void main(String[] args) throws IOException {
//1.获取字节输入流
InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
//2.根据字节输入流构建SqlSessionFactory
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);
//3.根据SqlSessionFactory生产一个SqlSeesion
SqlSession session = factory.openSession();
//4.使用sqlSession获取dao的代理对象
IUserDao userDao = session.getMapper(IUserDao.class);
//5.执行dao的方法
List<User> users = userDao.findAll();
for (User user : users) {
System.out.println(user);
}
//6.释放资源
session.close();
in.close();
}
}
执行一下,完全没有问题:
这样我们的环境就算是搭建成功了!
· 注意事项
我们要额外注意一点,如果我们在使用注解的同时配置了xml映射文件,我们再次运行测试类,就会报错:
二、单表CRUD操作(代理Dao方式)
1. 常用注解说明
@Insert
:实现新增@Update
:实现更新@Delete
:实现删除@Select
:实现查询@Result
:实现结果集封装@Results
:可以与@Result
一起使用,封装多个结果集@ResultMap
:实现引用@Results
定义的封装@One
:实现一对一结果集封装@Many
:实现一对多结果集封装@SelectProvider
: 实现动态 SQL 映射@CacheNamespace
:实现注解二级缓存的使用
2. 保存用户的操作
IUserDao:
/** * 添加用户 * * @param user */
@Insert("insert into user(username,address,sex,birthday) values(#{username},#{address},#{sex},#{birthday})")
void saveUser(User user);
测试:
public class AnnotationCRUDTest {
private InputStream in;
private SqlSessionFactory factory;
private SqlSession session;
private IUserDao userDao;
@Before
public void init() throws IOException {
in = Resources.getResourceAsStream("SqlMapConfig.xml");
factory = new SqlSessionFactoryBuilder().build(in);
session = factory.openSession();
userDao = session.getMapper(IUserDao.class);
}
@After
public void destroy() throws IOException {
session.commit();
session.close();
in.close();
}
/** * 测试查询所有用户的信息 */
@Test
public void testFindAll() {
List<User> users = userDao.findAll();
for (User user : users) {
System.out.println(user);
}
}
/** * 测试:添加用户 */
@Test
public void testAddUser() {
User user = new User();
user.setUsername("新用户");
user.setBirthday(new Date());
user.setSex("男");
user.setAddress("珠穆朗玛峰");
userDao.saveUser(user);
testFindAll();
}
}
结果:
3. 更新用户的操作
IUserDao:
/** * 根据id更新用户的信息 * * @param user */
@Update("update user " +
"set username=#{username},sex=#{sex},address=#{address},birthday=#{birthday} " +
"where id=#{id}")
void updateUser(User user);
测试方法:
/** * 测试:添加用户 */
@Test
public void testUpdateUser() {
User user = new User();
user.setUsername("超级新用户");
user.setBirthday(new Date());
user.setSex("男");
user.setAddress("不是珠穆朗玛峰");
user.setId(75);
userDao.updateUser(user);
testFindAll();
}
测试结果:
4. 删除用户
IUserDao:
/** * 删除用户 * * @param id */
@Delete("delete from user where id=#{id}")
void deleteUserByid(Integer id);
测试方法:
/** * 测试删除用户 */
@Test
public void testDeleteUser() {
userDao.deleteUserByid(75);
testFindAll();
}
结果:
5. 根据id查询用户信息
IUserDao:
/** * 根据用户id查询用户信息 * * @param id * @return */
@Select("select * from user where id=#{id}")
User findUserById(Integer id);
测试方法:
/** * 根据用户id查询用户信息 */
@Test
public void testFindUserById() {
User user = userDao.findUserById(41);
System.out.println(user);
}
结果:
6. 根据用户名称进行模糊查询
IUserDao:
/** * 根据用户名查询用户信息 * * @param username * @return */
@Select("select * from user where username like #{username}")
List<User> findUserByUsername(String username);
测试方法:
/** * 测试:根据用户名查询用户信息 */
@Test
public void testFindUserByUsername() {
List<User> users = userDao.findUserByUsername("%刘%");
for (User user : users) {
System.out.println(user);
}
}
或者使用:
结果:
7. 查询用户数量
IUserDao:
/** * 查询总用户数量 * * @return */
@Select("select count(*) from user")
int findTotal();
测试方法:
/** * 测试:查询用户数量 */
@Test
public void testFindTotal() {
int count = userDao.findTotal();
System.out.println(count);
}
结果:
8. 用注解建立实体类和数据库列名的关系
如果我们的实体类中的属性名和数据库中的列名不相同的话,那么我们要进行额外的配置。
例如查询所有的操作:
/** * 查询所有用户信息 * * @return */
@Select("select * from user")
@Results(id = "userMap", value = {
@Result(id = true, column = "id", property = "userId"),
@Result(column = "username", property = "userName"),
@Result(column = "sex", property = "userSex"),
@Result(column = "address", property = "userAddress"),
@Result(column = "birthday", property = "userBirthday")
})
List<User> findAll();
而且我们在上面指定了Results的id,那么在下面其他的方法中就可以不用再定义一遍了,可以直接引用它的id就行了。
即:
/** * 根据用户名查询用户信息 * * @param username * @return */
@Select("select * from user where username like '%${value}%' ")
@ResultMap(value = "userMap")
List<User> findUserByUsername(String username);
三、复杂关系映射开发、多表操作
实现复杂关系映射之前我们可以在映射文件中通过配置<resultMap>
来实现,在使用注解开发时我们需要借助@Results
注解,@Result
注解,@One
注解,@Many
注解。
1. 复杂关系映射的注解说明
@Results
注解
代替的是标签<resultMap>
该注解中可以使用单个@Result 注解,也可以使用@Result 集合@Results({@Result(),@Result()})
或@Results(@Result())
@Resutl
注解
代替了 <id>
标签和<result>
标签
@Result
中 属性介绍:id
是否是主键字段column
数据库的列名property
需要装配的属性名one
需要使用的@One
注解(@Result(one=@One)()))
many
需要使用的@Many
注解(@Result(many=@many)()))
@One
注解(一对一)
代替了<assocation>
标签,是多表查询的关键,在注解中用来指定子查询返回单一对象。
@One 注解属性介绍:select
指定用来多表查询的 sqlmapperfetchType
会覆盖全局的配置参数 lazyLoadingEnabled
使用格式:@Result(column="",property="",one=@One(select=""))
@Many
注解(多对一)
代替了<Collection>
标签,是是多表查询的关键,在注解中用来指定子查询返回对象集合。
注意:聚集元素用来处理“一对多”的关系。需要指定映射的 Java 实体类的属性,属性的 javaType(一般为ArrayList)但是注解中可以不定义;
使用格式: @Result(property="",column="",many=@Many(select=""))
2. 实现一对一复杂关系映射及延迟加载
需求:
加载账户信息时并且加载该账户的用户信息,根据情况可实现延迟加载。
① User实体类 和 Account实体类
package com.veeja.domain;
public class User implements Serializable {
private Integer userId;
private String userName;
private String userAddress;
private String userSex;
private Date userBirthday;
@Override
public String toString() {
return "User{" +
"userId=" + userId +
", userName='" + userName + '\'' +
", userAddress='" + userAddress + '\'' +
", userSex='" + userSex + '\'' +
", userBirthday=" + userBirthday +
'}';
}
public Integer getUserId() {
return userId;
}
public void setUserId(Integer userId) {
this.userId = userId;
}
......
}
package com.veeja.domain;
import java.util.List;
/** * @author veeja */
public class Account {
private Integer id;
private Integer uid;
private Double money;
// 多对一(mybatis中称之为一对一)的对应关系
private User user;
@Override
public String toString() {
return "Account{" +
"id=" + id +
", uid=" + uid +
", money=" + money +
", user=" + user +
'}';
}
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public Integer getUid() {
return uid;
}
public void setUid(Integer uid) {
this.uid = uid;
}
public Double getMoney() {
return money;
}
public void setMoney(Double money) {
this.money = money;
}
public User getUser() {
return user;
}
public void setUser(User user) {
this.user = user;
}
}
② 持久层接口(使用注解配置)
IAccountDao:
/** * 查找所有的账户信息,并且获取每个用户所属的用户的信息 * * @return */
@Select("select * from account")
@Results(id = "accountMap", value = {
@Result(id = true, column = "id", property = "id"),
@Result(column = "uid", property = "uid"),
@Result(column = "money", property = "money"),
@Result(property = "user",
column = "uid",
one = @One(
select = "com.veeja.dao.IUserDao.findUserById",
fetchType = FetchType.EAGER))
})
List<Account> findAll();
IUserDao:
/** * IUserDao接口 */
public interface IUserDao {
/** * 查询所有用户信息 * * @return */
@Select("select * from user")
@Results(id = "userMap",value = {
@Result(id = true, column = "id", property = "userId"),
@Result(column = "username", property = "userName"),
@Result(column = "sex", property = "userSex"),
@Result(column = "address", property = "userAddress"),
@Result(column = "birthday", property = "userBirthday")
})
List<User> findAll();
/** * 根据用户id查询用户信息 * * @param id * @return */
@Select("select * from user where id=#{id}")
@ResultMap(value = "userMap")
User findUserById(Integer id);
}
③ 测试类
/** * 测试:查询所有用户信息 */
@Test
public void testFindAll() {
List<Account> accounts = accountDao.findAll();
for (Account account : accounts) {
System.out.println(account);
}
}
结果:
3. 一对多的复杂关系映射
需求:
查询用户信息时,也要查询他的账户列表。
① User
实体类中加入List<Account>
public class User implements Serializable {
private Integer userId;
private String userName;
private String userAddress;
private String userSex;
private Date userBirthday;
List<Account> accounts;
public List<Account> getAccounts() {
return accounts;
}
public void setAccounts(List<Account> accounts) {
this.accounts = accounts;
}
......
}
② 持久层接口配置
IUserDao:
/** * IUserDao接口 */
public interface IUserDao {
/** * 查询所有用户信息 * * @return */
@Select("select * from user")
@Results(id = "userMap", value = {
@Result(id = true, column = "id", property = "userId"),
@Result(column = "username", property = "userName"),
@Result(column = "sex", property = "userSex"),
@Result(column = "address", property = "userAddress"),
@Result(column = "birthday", property = "userBirthday"),
@Result(property = "accounts",
column = "id",
many = @Many(
select = "com.veeja.dao.IAccountDao.findAccountsByUid",
fetchType = FetchType.LAZY
))
})
List<User> findAll();
/** * 根据用户id查询用户信息 * * @param id * @return */
@Select("select * from user where id=#{id}")
@ResultMap(value = "userMap")
User findUserById(Integer id);
}
IAccountDao:
public interface IAccountDao {
/** * 查找所有的账户信息,并且获取每个用户所属的用户的信息 * * @return */
@Select("select * from account")
@Results(id = "accountMap", value = {
@Result(id = true, column = "id", property = "id"),
@Result(column = "uid", property = "uid"),
@Result(column = "money", property = "money"),
@Result(property = "user",
column = "uid",
one = @One(
select = "com.veeja.dao.IUserDao.findUserById",
fetchType = FetchType.EAGER))
})
List<Account> findAll();
/** * 根据用户id查询用户的账号信息 * * @return */
@Select("select * from account where uid=#{uid}")
List<Account> findAccountsByUid(Integer uid);
}
③ 测试方法:
/** * 测试:查询所有用户信息 */
@Test
public void testFindAll() {
List<User> users = userDao.findAll();
for (User user : users) {
System.out.println(user);
System.out.println(user.getAccounts());
}
}
结果:
四、缓存的配置
1. 在SqlMapConfig.xml中开启二级缓存支持
<settings>
<setting name="cacheEnabled" value="true"/>
</settings>
2. 在持久层接口中使用注解配置二级缓存
/** * IUserDao接口 */
@CacheNamespace(blocking = true)
public interface IUserDao {
......
}
3. 测试方法
InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);
//使用第一个session操作
SqlSession session = factory.openSession();
IUserDao userDao = session.getMapper(IUserDao.class);
User user = userDao.findUserById(41);
System.out.println(user);
System.out.println(user.getAccounts());
session.close();
// 使用第二个session操作
SqlSession session2 = factory.openSession();
IUserDao userDao2 = session2.getMapper(IUserDao.class);
User user2 = userDao2.findUserById(41);
System.out.println(user2);
System.out.println(user2.getAccounts());
session2.close();
in.close();
结果,我们是可以看到,只进行了一次查询的:
end.
mybatis的系列算是结束了,基础知识基本上都总结了。
还没有评论,来说两句吧...