引入:
mybatis进行数据查询既可以通过配置xml文件,也可以通过注解,在前几篇文章中,我们一直使用的都是通过配置xml文件,对于使用注解并没有详细的解释,只是简单的使用了一下,下面这篇文章,我们就重点学习一下mybatis中如何使用注解进行开发!
使用注解开发的步骤:
第一步:在mapper接口对应的方法上通过对应的注解实现SQL语句
@Select("select * from mybatis.students") List<user> getUser();
第二步:需要在配置核心文件中绑定接口
<mappers> <mapper class="dao.userMapper"/> </mappers>
简单实例应用:
本篇文章之列出代码,具体的工程创建方法,可参考之前的文章
mybatis_utils 类中:
package dao; 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; public class mybatis_utils { private static SqlSessionFactory sqlSessionFactory; static { try { String resource = "mybatis-config.xml"; InputStream inputStream = Resources.getResourceAsStream(resource); sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream); } catch (IOException e) { e.printStackTrace(); } } public static SqlSession getSqlSession () { SqlSession sqlSession = sqlSessionFactory.openSession(); return sqlSession; } }
userMapper类中:
xml文件配置的开发方式,是将SQL语句写在了文件中,而通过注解的方式,是将SQL语句用注解的方式写在对应的mapper接口的对应的方法上:
package dao; import org.apache.ibatis.annotations.Select; import pojo.user; import java.util.List; public interface userMapper { @Select("select * from mybatis.students") List<user> getUser(); }
user实体类:
package pojo; import org.apache.ibatis.type.Alias; public class user { private int id; private String name; private String password; public int getId() { return id; } public void setId(int id) { this.id = id; } public String getName() { return name; } public void setName(String name) { this.name = name; } public String getPassword() { return password; } public void setPassword(String password) { this.password = password; } public user() { } public user(int id,String name,String password){ this.id=id; this.name=name; this.password=password; } @Override public String toString() { return "user{" + "id=" + id + ", name='" + name + '\'' + ", password='" + password + '\'' + '}'; } }
db.properties文件:
注:我这里使用的是引入外部配置文件的方式,具体方法可参考之前的文章
driver=com.mysql.jdbc.Driver url=jdbc:mysql://localhost:3306/mybatis?useSSL=false&useUnicode=true&characterEncoding=utf-8 user=root password=xxx
log4j.properties文件:
log4j.rootLogger=DEBUG,console,file log4j.appender.console = org.apache.log4j.ConsoleAppender log4j.appender.console.Target = System.out log4j.appender.console.Threshold=DEBUG log4j.appender.console.layout = org.apache.log4j.PatternLayout log4j.appender.console.layout.ConversionPattern=[%c]-%m%n log4j.appender.file = org.apache.log4j.RollingFileAppender log4j.appender.file.Encoding=UTF-8 log4j.appender.file.File=./log/dai.log log4j.appender.file.MaxFileSize=10mb log4j.appender.file.Threshold=DEBUG log4j.appender.file.layout=org.apache.log4j.PatternLayout log4j.appender.file.layout.ConversionPattern=[%p][???:%d{yy-MM-dd}][%c]%m%n log4j.logger.org.mybatis=DEBUG log4j.logger.java.sql=DEBUG log4j.logger.java.sql.Statement=DEBUG log4j.logger.java.sql.ResultSet=DEBUG log4j.logger.java.sql.PreparedStatement=DEBUG
mybatis-config.xml文件:
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "https://mybatis.org/dtd/mybatis-3-config.dtd"> <configuration> <settings> <setting name="logImpl" value="STDOUT_LOGGING"/> </settings> <typeAliases> <package name="pojo"/> </typeAliases> <environments default="development"> <environment id="development"> <transactionManager type="JDBC"/> <dataSource type="POOLED"> <property name="driver" value="${driver}"/> <property name="url" value="${url}"/> <property name="username" value="${username}"/> <property name="password" value="${password}"/> </dataSource> </environment> </environments> <!--使用注解代替配置文件,那么这里从原来的绑定配置文件变为绑定接口--> <mappers> <mapper class="dao.userMapper"/> </mappers> </configuration>
测试类:
package dao.user; import dao.mybatis_utils; import dao.userMapper; import org.apache.ibatis.session.SqlSession; import org.junit.Test; import pojo.user; import java.util.List; public class test{ @Test public void getUserByLimit(){ SqlSession sqlSession= mybatis_utils.getSqlSession(); userMapper usermapper= sqlSession.getMapper(userMapper.class); userMapper userMapper=sqlSession.getMapper(userMapper.class); List<user> userList=usermapper.getUser(); for(user user:userList){ System.out.println(user); } sqlSession.close(); } }
子工程—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> <parent> <groupId>org.example</groupId> <artifactId>Mybatis_1</artifactId> <version>1.0-SNAPSHOT</version> </parent> <artifactId>mybatis_1</artifactId> <packaging>jar</packaging> <build> <resources> <resource> <directory>src/main/java</directory> <includes> <include>**/*</include> </includes> <filtering>false</filtering> </resource> </resources> </build> <properties> <maven.compiler.source>8</maven.compiler.source> <maven.compiler.target>8</maven.compiler.target> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> </properties> <dependencies> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis</artifactId> <version>3.5.5</version> </dependency> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.13.1</version> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>8.0.31</version> </dependency> <dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>1.2.17</version> </dependency> </dependencies> </project>
父工程—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>org.example</groupId> <artifactId>Mybatis_1</artifactId> <version>1.0-SNAPSHOT</version> <packaging>pom</packaging> <modules> <module>mybatis_1</module> </modules> <properties> <maven.compiler.source>8</maven.compiler.source> <maven.compiler.target>8</maven.compiler.target> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> </properties> </project>
输出的部分结果如下:
我们会发现这里的password的值均为空,通过前面的学习,我们知道其原因是因为数据库中表的字段名,和java实体类中的属性名不一致导致
在之前的学习中,通过配置xml文件的方式,我们针对上述这种问题采取的办法是在xml文件中,采用映射结果集的方式,即使两个名称不一样,也能够正确的取到具体的值。
而使用注解的方式,针对这种问题就显得有点力不从心了,并且在面对较为复杂的SQL语句,我们也是不推荐使用注解的。
使用注解对数据库进行查询:
mybatis传入多个参数时:
当mybatis传入多个参数[超过一个]时,是需要用@Param来定义我们的参数的,由于Mybatis只能识别一个参数并匹配,因此当我们传入多个参数的时候,mybatis就无法识别了,解决办法有两种:一是使用Map,但是需要在使用xml配置文件的情况下使用,但是一般我们表面上看不到具体传的是什么参数,可读性较差,因此我们可以通过使用@Param来定义参数
举例:
传入一个参数:
接口中编写SQL语句:
测试类中调用方法,传递参数:
输出的部分结果如下:
传入多个参数:
接口中编写SQL语句:
测试类中调用方法,传递参数:
程序报错:
编译器告诉我们id未找到
修改接口中的代码,用@Param定义参数:
成功输出:
在修改的时候,我相信比较善于思考的小伙伴已经发现了,我使用@Param对参数进行定义的时候,里面的值和后面的属性名是完全相同的,那么必须这样做吗?
时间是检验真理的唯一标准,我们测试一下就知道了:
将@Param中的参数值修改:
程序报错,报错的原因和我们未使用@Param对参数进行定义时,一模一样:
其实经过上面的第一轮测试,前面基础扎实的小伙伴,应该都知道原因了,因为上面不是提到说,当mybatis传入多个参数[超过一个]时,是需要用@Param来定义我们的参数的,由于Mybatis只能识别一个参数并匹配,因此当我们传入多个参数的时候,mybatis就无法识别了,那么SQL语句中的参数只要与@Param中定义的参数名相对应即可,@Param的作用相当于给后面的参数重新定义了新的名字:
我们还是测试一下:
事实确实如此!
其他错误类:
以下错误为我个人在测试时,由于各种各样的原因所导致的,在这里分享出来,帮大家避个坑:
1:下述这种错误的原因是由于:不允许检索公钥
我的解决方案:在运行程序之前,将MySQL打开
2: 下述这种错误的原因是由于:selectOne()应返回一个结果(或空值)
,但返回2个结果
造成这种错误的原因是:
在接口中编写的SQL语句,其返回的结果为两个,是SQL语句的错误吗?
并不是,SQL语句并没有错,真正的错误在于,我们将接受SQL语句查询结果的返回值的类型设定为user类,它是一个实体类,根本没办法接受多条返回结果:
解决方法:
将接受SQL语句查询结果的返回值的类型设定为List:
此时再进行此时,两条记录均被输出!
使用注解对数据库进行增删改:
这里我们以增加为例!
增加用户信息:
第一步:在接口中编写方法和注解
第二步:在测试类中新建实体类对象,并传入参数的值
部分输出结果如下所示:
数据库中查询:
细心的小伙伴已经发现了,在测试类中,我们没有进行事务提交,为甚了mysql中还能够查询到新添加的事务呢?
原因:我开启了自动提交事务:
大家可以在测试类中添加断点,查看autoCommit的值:
设置方法如下:
打开mybatis_utils类:
通过设置自动提交事务,虽然比较方便,但是我们推荐的还是手动提交,因为在代码有问题的情况下,比如删除操作书写有误,自动提交此时就会显得有点“火上浇油”了
删除和修改操作的方法和上述的增加基本相似,这里就不进行举例了,大家可以自行进行练习
说到这里,关于mybatis使用注解进行开发的内容,我们基本就说完了,虽然使用注解来映射简单语句会使代码显得更加简洁,但对于稍微复杂一点的语句,Java 注解不仅力不从心,还会让本就复杂的 SQL 语句更加混乱不堪
因此,如果你需要做一些很复杂的操作,最好用 XML 来映射语句,但选择何种方式来配置映射,以及是否应该要统一映射语句定义的形式,完全取决于你和你的团队,换句话说,永远不要拘泥于一种方式,你可以很轻松地在基于注解和 XML 的语句映射方式间自由移植和切换
最后关于@Param()提醒几点需要注意的地方:
1:基本类型的参数或者String类型,需要加上,引用类型则不需要添加 2:如果参数只有一个基本类型,那么可加可不加,但是推荐加上! 3:在SQL中引用的就是@Param中定义的属性名