MyBatis:注解开发
在 MyBatis 的开发体系中,注解开发作为 XML 配置的补充方案,以其简洁直观的语法大幅简化了基础 CRUD 操作的代码编写。然而需要明确的是,该方式更适用于简单业务场景,不推荐在生产环境中大规模使用—— 复杂 SQL 的维护性、动态 SQL 的灵活性等方面仍不及 XML 配置。本文将从核心注解、配置方式、关联查询实现到测试流程,全面拆解 MyBatis 注解开发的关键知识点。
MyBatis 提供了一套原生注解对应 SQL 的增删改查操作,无需编写 XML 映射文件,直接在 Mapper 接口方法上添加注解即可完成 SQL 绑定,核心注解如下:
@Insert:添加
@Update:修改
@Delete:删除
@Select:查询
@Result:实现结果集封装
@Results:可以和@Result一起使用,封装多个结果集
@One:实现一对一和多对一的结果集封装
@Many:实现一对多结果级封装
一、使用注解完成CURD
1.SqlMapConfig,xml配置文件
使用注解开发时,需在 MyBatis 核心配置文件SqlMapConfig.xml中声明 Mapper 接口的扫描路径,让 MyBatis 能够识别注解对应的映射关系,主要有两种配置方式:
<mappers>
<!--第一种方式:class引入接口,只能引入一个接口-->
<mapper class="com.qcby.dao.UserAnnoDao"/>
<!--第二种方式:针对com.qcby.dao包下的所有的接口-->
<package name="com.qcby.dao"/>
</mappers>
注意:包扫描方式要求 Mapper 接口名与 XML 映射文件名(若存在)一致,且放置在同一包下,否则会导致映射失效。
2.UserDao接口方法和注释的编写
import com.qcby.entity.User;
import org.apache.ibatis.annotations.*;
import javax.jws.soap.SOAPBinding;
import java.util.List;
public interface UserDao {
//查询所有
@Select("select * from user")
@Results(id="userMap",value = {
@Result(property = "id",column = "id"),
@Result(property = "username",column = "username"),
@Result(property = "birthday",column = "birthday"),
@Result(property = "sex",column = "sex"),
@Result(property = "address",column = "address")
})
public List<User> findAll();
//通过ID查询
@Select("select * from user where id = #{id}")
@ResultMap(value = "userMap")
public User findById(int id);
//增加
@Insert("insert into user(username,birthday,sex,address) values(#{username},#{birthday},#{sex},#{address})")
@SelectKey(statement="select last_insert_id()",keyColumn = "id",keyProperty = "id",before =false,resultType =Integer.class)
public int insert(User user);
//更新
@Update("update user set username = #{username},birthday = #{birthday},sex = #{sex},address = #{address} where id = #{id}")
public int update(User user);
//删除
@Delete("delete from user where id = #{id}")
public int delete(int id);
//查询数量
@Select("select count(*) from user")
public int findCount();
//模糊查询
@Select("select * from user where username like concat('%',#{username},'%')")
public List<User> findByName(String username);
}
3.UserTest测试方法的编写
public class UserTest {
private InputStream in = null;
private SqlSession session = null;
private UserDao mapper = null;
@Before //前置通知, 在方法执行之前执行
public void init() throws IOException {
//加载主配置文件,目的是为了构建SqlSessionFactory对象
in = Resources.getResourceAsStream("SqlMapConfig.xml");
//创建SqlSessionFactory对象
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);
//通过SqlSessionFactory工厂对象创建SqlSesssion对象
session = factory.openSession();
//通过Session创建UserDao接口代理对象
mapper = session.getMapper(UserDao.class);
}
@After //@After: 后置通知, 在方法执行之后执行 。
public void destory() throws IOException {
//释放资源
session.close();
in.close();
}
/**
* 测试查询所有的方法
*/
@Test
public void findAll() throws IOException {
List<User> users = mapper.findAll();
for (User user:users) {
System.out.println(user.toString());
}
}
@Test
public void findById(){
User user = mapper.findById(4);
System.out.println(user.toString());
}
@Test
public void insert(){
User user = new User();
user.setSex("女");
user.setUsername("小美");
user.setBirthday(new Date());
user.setAddress("保定");
int insert = mapper.insert(user);
session.commit();
System.out.println(insert);
}
@Test
public void update(){
User user = new User();
user.setId(22);
user.setSex("女");
user.setUsername("小美");
user.setBirthday(new Date());
user.setAddress("上海");
int insert = mapper.update(user);
session.commit();
System.out.println(insert);
}
@Test
public void delete(){
int delete = mapper.delete(22);
session.commit();
System.out.println(delete);
}
@Test
public void findCount(){
int count = mapper.findCount();
session.commit();
System.out.println(count);
}
@Test
public void findByName(){
List<User> list = mapper.findByName("%a%");
for (User user : list) {
System.out.println(user);
}
session.close();
}
}
二、多对一的注解查询
1.多对一立即加载查询
①.StudentDao接口的方法编写
@Select(" SELECT student.*,teacher.Tname FROM student LEFT JOIN teacher on student.t_id = teacher.id")
@Results(value = {
@Result(property = "id",column = "id"),
@Result(property = "Sname",column = "Sname"),
@Result(property = "sex",column = "sex"),
@Result(property = "age",column = "age"),
@Result(property = "t_id",column = "t_id"),
@Result(property = "teacher.Tname",column = "Tname")
})
public List<Student> getStudent();
②.进行测试
@Test
public void getStudent(){
List<Student> student = mapper.getStudent();
for (Student student1:student) {
System.out.println(student1.toString());
}
}
2.多对一延迟加载查询
①.StudentDao接口的方法编写
@Select("select * from student")
@Results(value = {
@Result(property = "id",column = "id"),
@Result(property = "Sname",column = "Sname"),
@Result(property = "sex",column = "sex"),
@Result(property = "age",column = "age"),
@Result(property = "teacher",column = "t_id",one=@One(select = "com.qcby.dao.TeacherDao.getTeacher",fetchType = FetchType.LAZY))
})
public List<Student> getStudent();
②.TeacherDao接口的方法编写
@Select("select * from teacher where id = #{t_id}")
Teacher getTeacher(Integer id);
③.进行测试
@Test
public void getStudent(){
List<Student> student = mapper.getStudent();
for (Student student1:student) {
System.out.println(student1.toString());
}
}
三、一对多的注解查询
1.一对多延迟加载查询
①.TeacherDao接口的方法编写
//查询所有延迟加载
@Select("select * from Teacher")
@Results(value = {
@Result(property = "id",column = "id"),
@Result(property = "Tname",column = "Tname"),
@Result(property = "students",column = "id",many =@Many(select = "com.qcby.dao.StudentDao.findByUid",fetchType = FetchType.LAZY))
})
public List<Teacher> findAllLazy();
②.StudentDao接口的方法编写
@Select("select * from student where t_id = #{t_id}")
public Student findByUid(int uid);
③.进行测试
@Test
public void findAllLazy(){
List<Teacher> list = mapper.findAllLazy();
for (Teacher teacher: list) {
System.out.println(teacher.toString());
}
}
四、使用建议:注解开发 vs XML 配置
很多开发者纠结 “注解还是 XML”,核心是未明确二者的适用边界。以下从多个维度对比,给出场景化选择建议::
| 对比维度 | 注解开发 | XML 配置 |
|---|---|---|
| 适用场景 | 简单 CRUD、少量参数、无复杂逻辑的业务 | 复杂 SQL、动态条件(if/foreach)、多表关联复杂场景 |
| 代码可读性 | 简单 SQL 直观,复杂 SQL 混乱(注解内嵌套脚本) | 结构化清晰,SQL 与 Java 代码分离,易维护 |
| 动态 SQL 支持 | 有限(需嵌入<script>标签,语法繁琐) |
原生支持,标签丰富(if/choose/foreach 等) |
| SQL 复用 | 需通过 Java 方法复用,灵活性差 | 支持<sql>标签抽取公共 SQL,复用性强 |
| 生产环境推荐度 | ★★☆(仅适用于简单模块) | ★★★★★(通用首选) |
总结建议
- 简单 CRUD 场景(如管理后台基础数据操作):可使用注解开发,提升开发效率。
- 复杂业务场景(如多表关联、动态条件查询、SQL 优化需求高):优先使用 XML 配置,保证代码可维护性和灵活性。
- 混合使用:核心复杂 SQL 用 XML 配置,简单辅助操作用注解,兼顾效率与维护性。
五、总结
MyBatis 注解开发的核心价值是 “简化简单场景的编码成本”,但切勿盲目追求 “无 XML” 而忽视其局限性。掌握核心注解的进阶用法、关联查询的优化技巧、配置规范与问题排查方法,才能在实际开发中灵活运用 —— 简单场景用注解提升效率,复杂场景用 XML 保证可维护性,二者结合方能最大化 MyBatis 的开发价值。
若你在使用过程中遇到具体问题(如动态 SQL 注解实现、多数据源适配),欢迎在评论区交流,后续将针对性输出进阶教程!
更多推荐




所有评论(0)