Mybatis对数据库的基础操作---注解方式

最新推荐文章于 2024-09-24 08:52:30 发布
最新推荐文章于 2024-09-24 08:52:30 发布
阅读量1.3k 收藏 7
点赞数 2
文章标签： mybatis sql java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Tian_Cai_Wu_Ge/article/details/132050508
版权
本文介绍了在SpringBoot项目中使用Mybatis进行数据库操作，包括删除、预编译SQL、防止SQL注入、主键返回以及条件查询的实践，强调了预编译SQL的优势和参数占位符的使用。
摘要由CSDN通过智能技术生成

准备工作：

  1. 准备数据库表

  2. 创建一个新的springboot工程，选择引入对应的起步依赖（mybatis、mysql驱动、lombok）

  3. application.properties中引入数据库连接信息

  4. 创建对应的实体类 Emp（实体类属性采用驼峰命名）

  5. 准备Mapper接口 EmpMapper

删除：

需求：

当我们点击前端页面中的"删除"按钮时，前端页面会给服务端传递一个参数，也就是该行数据的ID。 我们接收到ID后，根据ID删除数据即可。

实现：

  • 使用SQL语句实现需求：
-- 删除id=17的数据
delete from emp where id = 17;

  • 使用Mybatis框架实现需求

@Mapper
public interface EmpMapper {
    
    //@Delete("delete from emp where id = 17")
    //public void delete();
    //以上delete操作的SQL语句中的id值写成固定的17，就表示只能删除id=17的用户数据
    //SQL语句中的id值不能写成固定数值，需要变为动态的数值
    //解决方案：在delete方法中添加一个参数(用户id)，将方法中的参数，传给SQL语句
    
    /**
     * 根据id删除数据
     * @param id    用户id
     */
    @Delete("delete from emp where id = #{id}")//使用#{key}方式获取方法中的参数值
    public void delete(Integer id);
    
}

@Delete注解：用于编写delete操作的SQL语句

如果mapper接口方法形参只有一个普通类型的参数，#{…} 里面的属性名可以随便写，如：#{id}、#{value}。但是建议保持名字一致。

日志输入：

在我们日常的开发过程中，为了方便开发中监控SQL语句的执行，通常会在Mybatis中借助日志，查看sql语句的执行、执行传递的参数以及执行结果。具体操作如下：

  1. 打开application.properties文件

  2. 开启mybatis的日志，并指定输出到控制台

#指定mybatis输出日志的位置, 输出控制台
mybatis.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

开启日志之后，我们再次运行单元测试，可以看到在控制台中，输出了以下的SQL语句信息：

 但是我们发现输出的SQL语句：delete from emp where id = ?，我们输入的参数16并没有在后面拼接，id的值是使用?进行占位。那这种SQL语句我们称为预编译SQL。

预编译SQL：

前面我们看到日志中输出的SQL语句带有?符号，这种SQL语句称为预编译SQL，那么预编译SQL有什么用呢？下面介绍来一下预编译SQL。

预编译SQL有两个优势：

  1. 性能更高
    性能更高：预编译SQL，编译一次之后会将编译后的SQL语句缓存起来，后面再次执行这条语句时，不会再次编译。（只是输入的参数不同）
  2. 更安全(防止SQL注入)
    更安全(防止SQL注入)：将敏感字进行转义，保障SQL的安全性。

SQL注入：

刚刚我们提到了SQL注入，下面我们就来聊聊SQL注入是什么：

SQL注入：是通过操作输入的数据来修改事先定义好的SQL语句，以达到执行代码对服务器进行攻击的方法。

由于没有对用户输入进行充分检查，而SQL又是拼接而成，在用户输入参数时，在参数中添加一些SQL关键字，达到改变SQL运行结果的目的，也可以完成恶意攻击。

参数占位符：

在前面我们书写的代码中，使用到两种参数占位符：${...} 、#{...}，那么这两种参数占位符有什么区别呢？

  • #{...}

    • 执行SQL时，会将#{…}替换为?，生成预编译SQL，会自动设置参数值

    • 使用时机：参数传递，都使用#{…}

  • ${...}

    • 拼接SQL。直接将参数拼接在SQL语句中，存在SQL注入问题

    • 使用时机：如果对表名、列表进行动态设置时使用

注意事项：在项目开发中，建议使用#{...}，生成预编译SQL，防止SQL注入安全

新增：

 实现：

  • 使用SQL语句实现需求：
insert into emp(username, name, gender, image, job, entrydate, dept_id, create_time,
update_time) values ('songyuanqiao','宋远桥',1,'1.jpg',2,'2012-10-09',2,'2022-10-01
10:00:00','2022-10-01 10:00:00');

  • 使用Mybatis框架实现需求

@Mapper
public interface EmpMapper {

    @Insert("insert into emp(username, name, gender, image, job, entrydate, dept_id,
create_time, update_time) values (#{username}, #{name}, #{gender}, #{image}, #{job}, #
{entrydate}, #{deptId}, #{createTime}, #{updateTime})")
    public void insert(Emp emp);

}

说明：#{...} 里面写的名称是对象的属性名（需要保持一致否则程序运行时会报错）

           emp（...）里面写的是数据库的字段名（需要保持一致否则程序运行时会报错）

日志输出：

 

主键返回：

我们开发中会存在一种需求，希望获取到新增数据的主键值，这种需求就需要用到主键返回技术

概念：

在数据添加成功后，需要获取插入数据库数据的主键。

业务场景：

添加套餐数据时，还需要维护套餐菜品关系表数据。

 

菜品与套餐模块的表结构，菜品与套餐是多对多的关系，一个套餐对应多个菜品。既然是多对多的关系，就需要有一张套餐菜品中间表来维护它们之间的关系。

 在添加套餐的时候，我们需要在界面当中来录入套餐的基本信息，还需要来录入套餐与菜品的关联信息。这些信息录入完毕之后，我们一点保存，就需要将套餐的信息以及套餐与菜品的关联信息都需要保存到数据库当中。其实具体的过程包括两步，首先第一步先需要将套餐的基本信息保存了，接下来第二步再来保存套餐与菜品的关联信息。套餐与菜品的关联信息就是往中间表当中来插入数据，来维护它们之间的关系。而中间表当中有两个外键字段，一个是菜品的ID，就是当前菜品的ID，还有一个就是套餐的ID，而这个套餐的 ID 指的就是此次我所添加的套餐的ID，所以我们在第一步保存完套餐的基本信息之后，就需要将套餐的主键值返回来供第二步进行使用。这个时候就需要用到主键返回功能。

如何实现在插入数据之后返回所插入行的主键值呢：

默认情况下，执行插入操作时，是不会主键值返回的。如果我们想要拿到主键值，只需要在Mapper接口中的方法上添加一个Options注解，并在注解中指定属性useGeneratedKeys=true和keyProperty="实体类属性名"（只能实现主键ID的返回，不能返回其他的属性值）

主键返回代码实现：

@Mapper
public interface EmpMapper {
    
    //会自动将生成的主键值，赋值给emp对象的id属性
    @Options(useGeneratedKeys = true,keyProperty = "id")
    @Insert("insert into emp(username, name, gender, image, job, entrydate, dept_id,
create_time, update_time) values (#{username}, #{name}, #{gender}, #{image}, #{job}, #
{entrydate}, #{deptId}, #{createTime}, #{updateTime})")
    public void insert(Emp emp);

}

更新：

 需求：

点击"编辑"按钮后，会查询所在行记录的员工信息，并把员工信息回显在修改员工的窗体上

在修改员工的窗体上，可以修改的员工数据：用户名、员工姓名、性别、图像、职位、入职日期、归属部门

在修改员工数据时，要以员工id做为条件

实现：

  • 使用SQL语句实现需求：
update emp set username = 'linghushaoxia', name = '令狐少侠', gender = 1 , image = '1.jpg' 
 job = 2, entrydate = '2012-01-01', dept_id = 2, update_time = '2022-10-01 12:12:12'
where id = 18;

  • 使用Mybatis框架实现需求

@Mapper
public interface EmpMapper {
    /**
     * 根据id修改员工信息
     * @param emp
     */
    @Update("update emp set username=#{username}, name=#{name}, gender=#{gender}, image=#
{image}, job=#{job}, entrydate=#{entrydate}, dept_id=#{deptId}, update_time=#{updateTime}
where id=#{id}")
    public void update(Emp emp);

注意：字段名=#{属性名}

字段名需要和数据库的字段名保持一致，属性名需要和对象的属性名保持一致否则代码会报错

 查询：

根据ID查询

在员工管理的页面中，当我们进行更新数据时，会点击 “编辑” 按钮，然后此时会发送一个请求到服务端，会根据Id查询该员工信息，并将员工数据回显在页面上。

 

实现：

  • 使用SQL语句实现需求：
select id, username, password, name, gender, image, job, entrydate, dept_id, create_time,
update_time from emp where id=1;

  • 使用Mybatis框架实现需求

@Mapper
public interface EmpMapper {
    @Select("select id, username, password, name, gender, image, job, entrydate, dept_id,
create_time, update_time from emp where id=#{id}")
    public Emp getById(Integer id);
}

执行结果：

数据缺失： 

在进行测试的过程中，我们发现有几个字段(deptId、createTime、updateTime)是没有数据值的

我们看到查询返回的结果中大部分字段是有值的，但是deptId，createTime，updateTime这几个字段是没有值的，而数据库中是有对应的字段值的，这是为什么呢？

原因如下：

  • 实体类属性名和数据库表查询返回的字段名一致，mybatis会自动封装。

  • 如果实体类属性名和数据库表查询返回的字段名不一致，不能自动封装。

解决方案：使字段名与属性名一致

  1. 起别名

  2. 结果映射

  3. 开启驼峰命名

起别名：（使用繁琐）

在SQL语句中，对不一样的列名起别名，别名和实体类属性名一样

@Select("select id, username, password, name, gender, image, job, entrydate, " +
        "dept_id AS deptId, create_time AS createTime, update_time AS updateTime " +
        "from emp " +
        "where id=#{id}")
public Emp getById(Integer id);
手动结果映射：（使用繁琐）

通过 @Results及@Result 进行手动结果映射

@Results({@Result(column = "dept_id", property = "deptId"),
          @Result(column = "create_time", property = "createTime"),
          @Result(column = "update_time", property = "updateTime")})
@Select("select id, username, password, name, gender, image, job, entrydate, dept_id,
create_time, update_time from emp where id=#{id}")
public Emp getById(Integer id);

@Results源代码：

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface Results {
String id() default "";

Result[] value() default {};  //Result类型的数组
}

@Result源代码：

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
@Repeatable(Results.class)
public @interface Result {
boolean id() default false;//表示当前列是否为主键（true:是主键）

String column() default "";//指定表中字段名

String property() default "";//指定类中属性名

Class<?> javaType() default void.class;

JdbcType jdbcType() default JdbcType.UNDEFINED;

Class<? extends TypeHandler> typeHandler() default UnknownTypeHandler.class;

One one() default @One;

Many many() default @Many;
}
开启驼峰命名(推荐)：（字段名与属性名需要符合驼峰命名规则）

如果字段名与属性名符合驼峰命名规则，mybatis会自动通过驼峰命名规则映射

驼峰命名规则： abc_xyz => abcXyz

  • 表中字段名：abc_xyz

  • 类中属性名：abcXyz

# 在application.properties中添加：
mybatis.configuration.map-underscore-to-camel-case=true

要使用驼峰命名前提是 实体类的属性 与 数据库表中的字段名严格遵守驼峰命名。

条件查询

在员工管理的列表页面中，我们需要根据条件查询员工信息，查询条件包括：姓名、性别、入职时间；

通过页面原型以及需求描述我们要实现的查询：

  • 姓名：要求支持模糊匹配

  • 性别：要求精确匹配

  • 入职时间：要求进行范围查询

  • 根据最后修改时间进行降序排序

实现：

  • 使用SQL语句实现需求：
select id, username, password, name, gender, image, job, entrydate, dept_id, create_time,
update_time 
from emp 
where name like '%张%' 
      and gender = 1 
      and entrydate between '2010-01-01' and '2020-01-01 ' 
order by update_time desc;

  • 使用Mybatis框架实现需求

    • 方式一：
@Mapper
public interface EmpMapper {
    @Select("select * from emp " +
            "where name like '%${name}%' " +
            "and gender = #{gender} " +
            "and entrydate between #{begin} and #{end} " +
            "order by update_time desc")
    public List<Emp> list(String name, Short gender, LocalDate begin, LocalDate end);
}

以上方式注意事项：

  1. 方法中的形参名和SQL语句中的参数占位符名保持一致

  2. 模糊查询使用${...}进行字符串拼接，这种方式呢，由于是字符串拼接，并不是预编译的形式，所以效率不高、且存在sql注入风险。

  • 使用Mybatis框架实现需求

    • 方式二：（解决SQL注入风险）
      • 使用MySQL提供的字符串拼接函数：concat('%' , '关键字' , '%')
@Mapper
public interface EmpMapper {

    @Select("select * from emp " +
            "where name like concat('%',#{name},'%') " +
            "and gender = #{gender} " +
            "and entrydate between #{begin} and #{end} " +
            "order by update_time desc")
    public List<Emp> list(String name, Short gender, LocalDate begin, LocalDate end);

}
执行结果：生成的SQL都是预编译的SQL语句（性能高、安全）

当方法中的形参名和SQL语句中的占位符参数名不相同时，就会出现以下问题：

 除了上述情况外，参数名在不同的SpringBoot版本中，处理方案还不同：

在springBoot的2.x版本（保证参数名一致）

 springBoot的父工程对compiler编译插件进行了默认的参数parameters配置，使得在编译时，会在生成的字节码文件中保留原方法形参的名称，所以#{…}里面可以直接通过形参名获取对应的值

在springBoot的1.x版本/单独使用mybatis（使用@Param注解来指定SQL语句中的参数名）

 在编译时，生成的字节码文件当中，不会保留Mapper接口中方法的形参名称，而是使用var1、var2、...这样的形参名字，此时要获取参数值时，就要通过@Param注解来指定SQL语句中的参数名

Tian_Cai_Wu_Ge
关注
mybatis-注解方式
mh_dream的博客
12-23 1764
文章目录1 主要注解2 单表查询2.1 配置文件2.2 接口类2.3 测试3 多表查询3.1 一对一查询3.1.1 接口类3.1.2 测试3.2 一对多查询3.2.1 接口类3.2.2 测试3.3 多对多查询3.3.1 接口类3.3.2 测试4 总结 结合mybatis-配置文件方式，搞懂注解方式。 1 主要注解 注解 标签 说明 @Insert insert 添加操作 @Update update 更新操作 @Delete delete 删除操作 @Select select
（实测有效）分别基于Spring(SpringMVC)中的XML和SpringBoot的Bean注解形式配置MyBatis中的databaseIdProvider多数据源支持
悲催的程序猿的博客
07-06 1241
随着互联网技术快速更新迭代，开发人员开发一个软件或系统业务的复杂度和数据量必然会成倍增加。与之对应的是数据库的结构也会更加复杂，一个业务可能并非仅用一个类型的数据库，也可能会同时使用多个数据库，因此如何在一个系统中能够灵活的切换和使用多个类型的数据库是至关重要的。
MyBatis-注解方式
最新发布
Flying_Fish_roe的博客
09-24 855
假设user表的字段与User类的属性不完全一致，例如表中的user_name字段对应User类的username属性。@Mapper@Results({})@Results：用于定义结果集的映射。@Result：定义字段到属性的映射关系，property表示实体类的属性，column表示数据库表的列。
数据库-注释
Nikkon的自留地
07-28 280
单行注释： --注释内容 单行注释：#注释内容 多行注释：/注释内容/
MyBatis学习——databaseIdProvider和databaseId
热门推荐
bobozai86的博客
04-13 1万+
有什么作用 databaseIdProvider和databaseId的作用简单来说就是让一个项目支持不同的数据库。 让一个项目支持不同的数据库在企业开发中是一个比较常见的需求。由于不同的数据库支持的sql语法稍有差别，所以某些功能需要根据数据库的不同书写不同的sql语句。对于这种需求，首先能够想到的解决方案就是针对不同的数据库维护不同的mapper.xml文件，但是这种方案会严重增加开发和维...
数据库注释
Missy_xw2018的博客
07-13 215
行注释:-- 块注释:/* */
mybatis-plus-doc-master.zip
05-05
MyBatis-Plus 是 MyBatis 的一个扩展，它简化了 CRUD 操作，提供了丰富的查询API，使得数据库操作更加便捷。这份"mybatis-plus-doc-master.zip"压缩包包含的是 MyBatis-Plus 的官方文档，对于理解和使用这个框架非常...
mybatis-plus快速入门项目-mybatis-plus基本操作大全-附带sql+项目文档
11-24
这个“mybatis-plus快速入门项目”是专为初学者设计的，旨在帮助他们快速掌握MyBatis-Plus的基本操作。在这个项目中，你将学习到如何配置、使用以及执行各种SQL操作。 1. **MyBatis-Plus简介** MyBatis-Plus（简称...
mybatis-generator-core-1.3.2
05-24
使用Mybatis Generator时，首先需要在项目的类路径下放置配置文件，并指定要操作的数据库表。配置文件中可以定义生成的Java模型类、Mapper接口和XML映射文件的命名规则。然后，通过执行Java程序或Maven插件，Mybatis...
spring-boot-starter-mybatis-spring-boot-1.0.2.zip
04-19
总之，"spring-boot-starter-mybatis-spring-boot-1.0.2.zip"压缩包提供了一个方便的Spring Boot与MyBatis集成方案，通过简单的步骤，我们可以在Spring Boot应用中便捷地使用MyBatis进行数据库操作。这个版本适用于...
mybatis-plus-dynamic-datasource
07-12
总结起来，mybatis-plus-dynamic-datasource 为开发者提供了一种优雅的方式去管理和切换多数据源，同时保持了 MyBatis-Plus 的强大功能，使得在复杂业务场景下的数据库操作变得更为便捷和可控。在实际项目中，合理...
用注解的方式实现数据库类
08-25
在类的声明中添加数据库表和注释，在类的变量中，增加数据库表字段的名称，类型和注释
java数据库注解_java 注解
weixin_30848953的博客
02-25 325
注解注解是一个接口，程序通过反射机制获得指定程序元素的Annotion对象。通过这个对象来获取注解里的元数据。元数据mysql中有元数据的概念，是对数据的数据的一种描述例如mysql中的元数据可以获得数据库服务器当前的状态，服务器的版本号。元注解负责注解其他注解栗子@Retention(RetetionPolicy.RUNTIME)@Target(ElementType.TYPE)public @...
各种数据库的注释
魔亦有道的博客
03-01 8343
OracleREM单行注释-- 单行注释/*多行注释*/ MS SQL Server-- 单行注释/*多行注释*/ MySQL#单行注释-- 单行注释（特别注意，-- 后有个空格！！！）/*多行注释*/ 总结：/*多行注释*/ 和-- 单行注释都差不多，MySQL要注意。非标准的#和REM最好还是不要用了为了兼容-- 后面最好都加空格 MySQL注释的说明－－－－－－－－－－－－－－－－－－－－
MyBatis：使用注解让数据库操作更简单
TaloyerG的博客
08-24 1342
在Java开发中，数据库操作是一个常见而重要的任务。为了方便地执行SQL语句，获取结果集，处理异常等，我们通常需要使用JDBC（Java Database Connectivity）API，这是一个标准的数据库访问接口。我们需要编写大量的重复代码，如加载驱动，创建连接，关闭资源等。我们需要手动设置参数和获取结果集，这可能导致类型不匹配或空指针等错误。我们需要硬编码SQL语句，这可能导致可读性和维护性的问题。
java数据库注解_Java注解及通过自定义Java注解实现数据库的操作
weixin_34887221的博客
02-25 1467
在Java程序中通过注解，可以让编程更加简洁、代码更加清晰。因此在Java框架代码中，嵌入了大量的注解。讲注解，首先得讲注解的概念：Java提供了一种原程序中的元素关联任何信息和任何元数据的途径和方法。一、注解的分类1、按照运行机制分为源码注解、编译注解和运行时注解(1)源码注解：注解只在源码中存在，编译成.class文件就不存在了(2)编译注解：注解在源码和.class文件中都存在，如JDK的三...
数据库事务控制注解说明
weixin_33978044的博客
03-12 219
关于事务控制的注解: // @Transactional(isolation = Isolation.REPEATABLE_READ, rollbackForClassName = {"Exception.class"}) @Transactional(propagation = Propagation.REQUIRED, isolation = Isolation.REPEATABLE_...
MyBatis: databaseId的用法
amadeus_liu2的博客
09-07 2336
这样，当MyBatis运行时，会根据当前的数据库是Oracle还是MySQL来匹配不同的SQL语句来执行。可以通过databaseId来区分执行的SQL是在MySQL上还是在Oracle上。二、根据不同的数据库语法写不同的SQL语句并配置相同的id。
springboot使用Mybatis中兼容多数据源的databaseId（databaseIdProvider）的简单使用方法
Variazioni的博客
04-22 3322
最近有兼容多数据库的需求，原有数据库使用的mysql，现在需要同时兼容mysql和pgsql，后期可能会兼容更多。mysql和pgsql很多语法和函数不同，所以有些sql需要写两份，于是在全网搜索如何在mapper中sql不通用的情况下兼容多数据库，中文网络下，能搜到的解决方案大概有两种：1.使用@DS注解的动态数据源；2.使用数据库厂商标识，即databaseIdProvider。第一种多用来同时连接多个数据源，且配置复杂，暂不考虑。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值