SpringBoot使用注解方式整合Mybatis,Mybatis常用注解总结

引入依赖

Mybatis、mysql驱动、druid数据源
<dependencies>
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>1.3.1</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <scope>runtime</scope>
</dependency>
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.0.9</version>
</dependency>
</dependencies>

Person实体类

@Data
public class Person {

    private int pid;

    private String pname;

    private String personAddr;

    private int gender;

    private Date birth;

}

Mapper接口

这里的注解Mapper表示

@Mapper
public interface PersonMapper {


    @Select("select * from person t where t.pid = #{pid}")
    public Person selectById(int pid);

    @Select("select * from person")
    public List<Person> selectAll();

    @Options(useGeneratedKeys = true, keyProperty = "pid")
    @Insert("insert into person(pid, pname, addr, gender, birth)values(#{pid},#{pname},#{addr},#{gender},#{birth} )")
    public void insert(Person p);


    @Select("delete  from person  where pid = #{pid}")
    public void delete(int pid);
}
  • 这里的@Mapper注解mybatis的自动配置里会扫描springboot的有效包路径下的带有@Mapper注解的接口,然后根据里面的mybatis注解生成mapper代理类。
  • 也可以在主程序启动类使用@MapperScan进行注解,指定Mapper包的位置即可,这样就省去了在每一个类上添加@Mapper注解的麻烦。如下
@SpringBootApplication
@MapperScan("cn.sboot.mapper")
public class FirstSpringApplication {
    public static void main(String[] args) {
        SpringApplication.run(FirstSpringApplication.class, args);
    }
}

Mybatis常用注解

  • Mybatis常用的注解分为三大类
  1. SQL语句映射类
  2. 结果集映射类
  3. 关系映射类
1、SQL语句映射类
1.1 @Insert 实现新增(插入)功能
@Insert("insert into user(id,name) values(#{id},#{name})")
@Options(useGeneratedKeys = true, keyColumn = "id", keyProperty = "id") 
public int insert(User user);
  • @Options注解
  • 设置@Options属性userGeneratedKeys的值为true,并指定实例对象中主键的属性名keyProperty以及在数据库中的字段名keyColumn。这样在插入数据后,该字段(属性)在数据,数据库中会被自动赋值。
  • 注意keyProperty指的是实例对象中属性,keyColumn指的是对应的数据库字段
@Insert("insert into user(name,sex,age) values(#{name},#{sex},#{age}")
int saveUser(User user);
1.2 @Select 实现查询功能
@Select("Select * from user")
@Results({
    @Result(id = true, column = "id", property = "id"),
    @Result(column = "name", property = "name"),
    @Result(column = "sex", property = "sex"),
    @Result(column = "age", property = "age")
})
List<User> queryAllUser();
1.3 @Update注解:实现更新功能
@Update("update user set name= #{name},sex = #{sex},age =#{age} where id = #{id}")
void updateUserById(User user);
1.4 @Delete注解:实现删除功能
@Delete("delete from  user  where id =#{id}")
void deleteById(Integer id);
(补充)1.5 @SelectKey注解:插入后,获取id的值
  • 以mysql为例,mysql在插入一条数据后,如何能获得到这个自增id的值呢?
  • 使用select last_insert_id()可以取到最后生成的主键。
  • 备注:before属性,默认是true,在执行插入语句之前,执行select last_insert_id()。如果设置为flase,则在插入这个语句之后,执行select last_insert_id()
@Insert("insert into user(id,name) values(#{id},#{name})")
@Options(useGeneratedKeys = true, keyColumn = "id", keyProperty = "id")
@SelectKey(statement = "select last_insert_id()" ,keyProperty = "id",keyColumn = "id",resultType = int.class,before = false) 
public int insert(User user);
2、结果集映射类

@Result,@Results,@ResultMap是结果集映射的三大注解。

2.1 @Results @Result
  • 声明结果集映射关系代码
@Select({"select id, name, class_id from student"})
@Results(id="studentMap", value={
    @Result(column="id", property="id", jdbcType=JdbcType.INTEGER, id=true),
    @Result(column="name", property="name", jdbcType=JdbcType.VARCHAR),
    @Result(column="class_id ", property="classId", jdbcType=JdbcType.INTEGER)
})
List<Student> selectAll();
  • @Results各个属性的含义
  • id为当前结果集声明唯一标识
  • value值为结果集映射关系
  • @Result代表一个字段的映射关系
  • column指定数据库字段的名称
  • property指定实体类属性的名称
  • jdbcType数据库字段类型
  • @Result里的id值为true表明主键,默认false;
2.2 @ResultMap
  • 使用@ResultMap来引用映射结果集,其中value可省略。
  • 这样就不用每次需要声明结果集映射的时候都复制冗余代码,简化开发,提高了代码的复用性。
  • 引用结果集代码
@Select({"select id, name, class_id from student where id = #{id}"})
@ResultMap(value="studentMap")
Student selectById(integer id);
3、关系映射类
3.1 @One 用于一对一关系映射
@Select("select * from student")  
@Results({  
    @Result(id=true,property="id",column="id"),  
    @Result(property="name",column="name"),  
    @Result(property="age",column="age"),  
    @Result(property="address",column="address_id",one=@One(select="cn.mybatis.mydemo.mappers.AddressMapper.getAddress"))  
})  
public List<Student> getAllStudents(); 
3.2 @Many 用于一对多关系映射
@Select("select * from t_class where id=#{id}")  
@Results({  
    @Result(id=true,column="id",property="id"),  
    @Result(column="class_name",property="className"),  
    @Result(property="students", column="id", many=@Many(select="cn.mybatis.mydemo.mappers.StudentMapper.getStudentsByClassId"))  
    })  
public Class getClass(int id); 
Spring Boot通过集成MyBatis框架,可以方便地利用注解方式简化持久层的操作。首先,需要添加MyBatis的依赖到项目,并配置数据源和SqlSessionFactory。以下是主要的步骤: 1. **添加依赖**: 在`pom.xml`文件添加mybatis-spring-boot-starter或mybatis plus的依赖。 ```xml <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> </dependency> ``` 2. **创建实体类(Entity)**: 使用`@Table`注解指定对应的数据库表名,`@MapperScan`注解用于扫描mapper接口所在的包。 ```java @Entity @Table(name = "users") public class User { // 实体属性... } ``` 3. **编写Mapper接口**: 使用`@Mapper`注解标明这是一个Mapper接口,然后定义CRUD操作方法。 ```java public interface UserRepository extends JpaRepository<User, Long> { @Insert("INSERT INTO users (name, age) VALUES (?, ?)") void insertUser(User user); @Select("SELECT * FROM users WHERE id = #{id}") User getUserById(@Param("id") Long id); // 更多其他查询、更新和删除操作... } ``` 4. **使用Service和Repository**: 创建业务Service类,注入对应Mapper接口,就可以直接使用这些注解生成的方法进行数据库操作了。 ```java @Service public class UserService { private final UserRepository userRepository; public UserService(UserRepository userRepository) { this.userRepository = userRepository; } public User createUser(User user) { return userRepository.insertUser(user); } // 使用其他方法... } ``` 5. **自动映射与事务管理**: Spring Boot会自动完成MyBatis的配置,包括XML文件的自动扫描,以及基于方法的SQL映射。对于事务管理,可以在Service层或者Controller层开启Transaction。 以上就是基本的Spring BootMyBatis通过注解方式集成的基本流程,它大大减少了手动配置的工作量。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值