Mybatis配置解析以及日志的处理，分页的使用，使用注解开发，Lombok入门
Posted a碟
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Mybatis配置解析以及日志的处理，分页的使用，使用注解开发，Lombok入门相关的知识，希望对你有一定的参考价值。
目录
1、配置解析
1.1、核心配置文件
-
mybatis-config.xml（官方建议取名）
-
MyBatis 的配置文件包含了会深深影响 MyBatis 行为的设置和属性信息。
configuration（配置） properties（属性） settings（设置） typeAliases（类型别名） typeHandlers（类型处理器） objectFactory（对象工厂） plugins（插件） environments（环境配置） environment（环境变量） transactionManager（事务管理器） dataSource（数据源） databaseIdProvider（数据库厂商标识） mappers（映射器）
1.2、环境配置（environments）
MyBatis 可以配置成适应多种环境
不过要记住：尽管可以配置多个环境，但每个 SqlSessionFactory 实例只能选择一种环境。
Mybatis默认的事务管理器就是 JDBC ， 连接池 ： POOLED
1.3、属性（properties）
通过properties属性来实现引用配置文件
这些属性都是可外部配置且可动态替换的，既可以在典型的 Java 属性文件中配置，亦可通过 properties 元素的子元素来传递。【db.properties】
编配置文件
db.properties
driver=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/mybatis?useSSL=false&useUnicode=true&characterEncoding=UTF-8
username=root
password=123456
在核心配置文件中引入，写在最前面
<!--引入外部配置文件-->
<properties resource="db.properties">
<property name="username" value="root"/>
<property name="pwd" value="11111"/>
</properties>
- 可以直接引入外部文件
- 可以在其中增加一些属性配置
- 如果两个文件有同一个字段，优先使用外部配置文件的！
就如
<!--引入外部配置文件-->
<properties resource="db.properties">
<property name="username" value="root"/>
<property name="pwd" value="11111"/>
</properties>
优先使用外部配置文件的，这里面写的如果外部文件有，将不会被使用。
1.4、类型别名（typeAliases）
- 类型别名是为 Java 类型设置一个短的名字。‘
- 存在的意义仅在于用来减少类完全限定名的冗余。
typeAliases等这些配置都要按规定顺序写
<!--可以给实体类起别名-->
<typeAliases>
<typeAlias type="com.adie.pojo.User" alias="User"/>
</typeAliases>
也可以指定一个包名，MyBatis 会在包名下面搜索需要的 Java Bean，比如：
扫描实体类的包，它的默认别名就为这个类的 类名，首字母建议小写，大写也行
<!--可以给实体类起别名-->
<typeAliases>
<package name="com.kuang.pojo"/>
</typeAliases>
在实体类比较少的时候，使用第一种方式。
如果实体类十分多，建议使用第二种。
第一种可以DIY别名，第二种则不行，如果非要改，需要在实体上增加注解
@Alias("hello")
public class User {}
在扫描包的情况下，加了上述情况，则别名变成注解中的，注释优先级高。
用typeAlias设置别名时使用注解，两个都生效
1.5、设置
这是 MyBatis 中极为重要的调整设置，它们会改变 MyBatis 的运行时行为。
1.6、其他配置
用的很少的
- typeHandlers（类型处理器）
- objectFactory（对象工厂）
- plugins插件
- mybatis-generator-core(根据数据库文件自动生成增删改查)
- mybatis-plus（使用它可以让mybatis效率更高）
- 通用mapper
1.7、映射器（mappers）
MapperRegistry：注册绑定我们的Mapper文件；
方式一： 【推荐使用】
<!--每一个Mapper.XML都需要在Mybatis核心配置文件中注册！-->
<mappers>
<mapper resource="com/adie/dao/userMapper.xml"/>
</mappers>
方式二：使用class文件绑定注册
<!--每一个Mapper.XML都需要在Mybatis核心配置文件中注册！-->
<mappers>
<mapper class="com.adie.dao.UserMapper"/>
</mappers>
注意点：
- 接口和他的Mapper配置文件必须同名！
- 接口和他的Mapper配置文件必须在同一个包下！
方式三：使用扫描包进行注入绑定
<!--每一个Mapper.XML都需要在Mybatis核心配置文件中注册！-->
<mappers>
<package name="com.adie.dao"/>
</mappers>
注意点：
- 接口和他的Mapper配置文件必须同名！
- 接口和他的Mapper配置文件必须在同一个包下！
（也可以在resources下创建同位置的文件夹，放在里面）
1.8、生命周期和作用域
生命周期，和作用域，是至关重要的，因为错误的使用会导致非常严重的并发问题。
SqlSessionFactoryBuilder：
- 一旦创建了 SqlSessionFactory，就不再需要它了
- 局部变量
SqlSessionFactory：
- 说白了就是可以想象为 ：数据库连接池
- SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在，没有任何理由丢弃它或重新创建另一个实例。
- 因此 SqlSessionFactory 的最佳作用域是应用作用域。
- 最简单的就是使用单例模式或者静态单例模式。
SqlSession
- 连接到连接池的一个请求！
- SqlSession 的实例不是线程安全的，因此是不能被共享的，所以它的最佳的作用域是请求或方法作用域。
- 用完之后需要赶紧关闭，否则资源被占用！
这里面的每一个Mapper，就代表一个具体的业务！
2、解决属性名和字段名不一致的问题
2.1、 问题
数据库中的字段
新建一个项目，拷贝之前的，测试实体类字段不一致的情况
public class User {
private int id;
private String name;
private String password;
}
测试出现问题
password为空
// select * from mybatis.user where id = #{id}
//类型处理器
// select id,name,pwd from mybatis.user where id = #{id}
解决方法：
-
起别名
<select id="getUserById" resultType="com.adie.pojo.User"> select id,name,pwd as password from mybatis.user where id = #{id} </select>
2.2、resultMap
结果集映射
id name pwd
id name password
<!--结果集映射-->
<resultMap id="UserMap" type="User">
<!--column数据库中的字段，property实体类中的属性-->
<result column="id" property="id"/>
<result column="name" property="name"/>
<result column="pwd" property="password"/>
</resultMap>
<select id="getUserById" resultMap="UserMap">
select * from mybatis.user where id = #{id}
</select>
resultMap元素是 MyBatis 中最重要最强大的元素- ResultMap 的设计思想是，对于简单的语句根本不需要配置显式的结果映射，而对于复杂一点的语句只需要描述它们的关系就行了。
ResultMap最优秀的地方在于，虽然你已经对它相当了解了，但是根本就不需要显式地用到他们。
3、日志
3.1、日志工厂
如果一个数据库操作，出现了异常，我们需要排错。日志就是最好的助手！
曾经打印日志：sout 、debug
现在：日志工厂
-
SLF4J
-
LOG4J 【掌握】
-
LOG4J2
-
JDK_LOGGING
-
COMMONS_LOGGING
-
STDOUT_LOGGING 【掌握】
-
NO_LOGGING
在Mybatis中具体使用那个一日志实现，在设置中设定
STDOUT_LOGGING标准日志输出
在mybatis核心配置文件中，配置我们的日志
<settings>
<setting name="logImpl" value="STDOUT_LOGGING"/>
</settings>
3.2、Log4j
- Log4j是Apache的一个开源项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件
- 我们也可以控制每一条日志的输出格式；
- 通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。
- 通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。
-
先导入log4j的包
<!-- https://mvnrepository.com/artifact/log4j/log4j --> <dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>1.2.17</version> </dependency> -
log4j.properties
#将等级为DEBUG的日志信息输出到console和file这两个目的地，console和file的定义在下面的代码 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.File=./log/adie.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 -
配置log4j为日志的实现
空格不要多，字母严格区分大小写不要错
<settings> <setting name="logImpl" value="LOG4J"/> </settings> -
Log4j的使用！直接测试运行刚才的查询
和前面的日志打印内容差不多，多了一些前缀
在配置文件中写好的目录下出现了一个log文件
简单使用
-
在要使用Log4j 的类中，导入包
import org.apache.log4j.Logger; -
日志对象，参数为当前类的class
static Logger logger = Logger.getLogger(UserDaoTest.class); -
日志级别
logger.info("info:进入了testLog4j"); logger.debug("debug:进入了testLog4j"); logger.error("error:进入了testLog4j");
4、分页
思考：为什么要分页？
- 减少数据的处理量
4.1、使用Limit分页
语法：SELECT * from user limit startIndex,pageSize;
SELECT * from user limit n; #[0,n]
使用Mybatis实现分页，核心SQL
-
接口
//分页 List<User> getUserByLimit(Map<String,Integer> map); -
Mapper.xml
<!--//分页--> <select id="getUserByLimit" parameterType="map" resultMap="UserMap"> select * from mybatis.user limit #{startIndex},#{pageSize} </select> -
测试
@Test public void getUserByLimit(){ SqlSession sqlSession=MybatisUtils.getSqlSession(); UserMapper mapper = sqlSession.getMapper(UserMapper.class); HashMap<String, Integer> map = new HashMap<>(); map.put("startIndex",1); map.put("pageSize",2); List<User> userList = mapper.getUserByLimit(map); for(User user:userList){ System.out.println(user); } sqlSession.close(); }
4.2、RowBounds分页
不再使用SQL实现分页
-
接口
//分页2 List<User> getUserByRowBounds(); -
mapper.xml
<!--分页2--> <select id="getUserByRowBounds" resultMap="UserMap"> select * from mybatis.user </select> -
测试
@Test public void getUserByRowBounds(){ SqlSession sqlSession = MybatisUtils.getSqlSession(); //RowBounds 实现 RowBounds rowBounds = new RowBounds(0, 2); // 通过java代码层面实现分页 List<User> userList = sqlSession.selectList("com.adie.dao.UserMapper.getUserByRowBounds",null,rowBounds); for(User user:userList){ System.out.println(user); } sqlSession.close(); }
4.3、分页插件
https://pagehelper.github.io/
了解即可，可去官网了解详细信息
5、使用注解开发
5.1、面向接口编程
- 大家之前都学过面向对象编程，也学习过接口，但在真正的开发中，很多时候我们会选择面向接口编程
- 根本原因 : 解耦 , 可拓展 , 提高复用 , 分层开发中 , 上层不用管具体的实现 , 大家都遵守共同的标准 , 使得开发变得容易 , 规范性更好
- 在一个面向对象的系统中，系统的各种功能是由许许多多的不同对象协作完成的。在这种情况下，各个对象内部是如何实现自己的,对系统设计人员来讲就不那么重要了；
- 而各个对象之间的协作关系则成为系统设计的关键。小到不同类之间的通信，大到各模块之间的交互，在系统设计之初都是要着重考虑的，这也是系统设计的主要工作内容。面向接口编程就是指按照这种思想来编程。
关于接口的理解
- 接口从更深层次的理解，应是定义（规范，约束）与实现（名实分离的原则）的分离。
- 接口的本身反映了系统设计人员对系统的抽象理解。
- 接口应有两类：
- 第一类是对一个个体的抽象，它可对应为一个抽象体(abstract class)；
- 第二类是对一个个体某一方面的抽象，即形成一个抽象面（interface）；
- 一个体有可能有多个抽象面。抽象体与抽象面是有区别的。
三个面向区别
- 面向对象是指，我们考虑问题时，以对象为单位，考虑它的属性及方法 .
- 面向过程是指，我们考虑问题时，以一个具体的流程（事务过程）为单位，考虑它的实现 .
- 接口设计与非接口设计是针对复用技术而言的，与面向对象（过程）不是一个问题.更多的体现就是对系统整体的架构
5.2、使用注解开发
-
注解在接口上实现
@Select("select * from user") List<User> getUsers(); -
需要在核心配置文件中绑定接口！
<mappers> <mapper class="com.adie.dao.UserMapper"/> </mappers> -
测试
使用注解可以使得代码更见简洁，但是一些复杂操作却力不从心了。上面password为空是因为之前设置的User类和数据库种的字段名不一致。使用注解开发的话这种问题很好解决。在前面也说过了
本质：反射机制实现
底层：动态代理
Mybatis详细的执行流程！
5.3、CRUD
我们可以在工具类创建的时候实现自动提交事务！
public static SqlSession getSqlSession(){
return sqlSessionFactory.openSession(true);
}
编写接口，增加注解
public interface UserMapper {
@Select("select * from user")
List<User> getUsers();
// 方法存在多个参数，所有的参数前面必须加上 @Param("id")注解
@Select("select * from user where id = #{id}")
User getUserByID(@Param("id") int id);
@Insert("insert into user(id,name,pwd) values (#{id},#{name},#{password})")
int addUser(User user);
@Update("update user set name=#{name},pwd=#{password} where id = #{id}")
int updateUser(User user);
@Delete("delete from user where id = #{uid}")
int deleteUser(@Param("uid") int id);
}
查询
// 方法存在多个参数，所有的参数前面必须加上 @Param("id")注解
@Select("select * from user where id = #{id}")
User getUserByID(@Param("id") int id);
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-PCa3Y7Qn-1627403124049)(Mybatis%E8%AF%BE%E5%A0%82%E7%AC%94%E8%AE%B0.assets/image-20210724112852186.png)]
增加
我们这里并没有提交事务，是因为我们在前面创建工具类的时候实现了自动提交
@Insert("insert into user(id,name,pwd) values (#{id},#{name},#{password})")
int addUser(User user);
修改
@Update("update user set name=#{name},pwd=#{password} where id = #{id}")
int updateUser(User user);
删除
@Delete("delete from user where id = #{uid}")
int deleteUser(@Param("uid") int id);
测试类
【注意：我们必须要讲接口注册绑定到我们的核心配置文件中！】
关于@Param() 注解
- 基本类型的参数或者String类型，需要加上
- 引用类型不需要加
- 如果只有一个基本类型的话，可以忽略，但是建议大家都加上！
- 我们在SQL中引用的就是我们这里的 @Param() 中设定的属性名！
#{} ${} 区别
和PreparedStatement和Statement类似
一般都使用#，防止sql注入
#{ }可以防止Sql 注入，它会将所有传入的参数作为一个字符串来处理。
$ {} 则将传入的参数拼接到Sql上去执行，一般用于表名和字段名参数，$ 所对应的参数应该由服务器端提供，前端可以用参数进行选择，避免 Sql 注入的风险
$不安全，容易被sql注入
大多数情况下还是经常使用#{}，一般能用#{}的就别用 ； 但 有 些 情 况 下 必 须 使 用 {}；但有些情况下必须使用 ；但有些情况下必须使用{}，例：MyBatis排序时使用ORDER BY动态参数时需要注意，得用${}而不是#{}。
6、Lombok
Project Lombok is a java library that automatically plugs into your editor and build tools, spicing up your java.
Never write another getter or equals method again, with one annotation your class has a fully featured builder, Automate your logging variables, and much more.
- java library java库
- plugs 插件
- build tools 构建工具
- with one annotation your class 不用再编写get，set等方法，只需要写注释
使用步骤：
-
在IDEA中安装Lombok插件！
-
在项目中导入lombok的jar包
<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok --> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.20</version> <scope>provided</scope> </dependency> -
在实体类上加注解即可！
@Data @AllArgsConstructor @NoArgsConstructor
@Getter and @Setter
@FieldNameConstants
@ToString
@EqualsAndHashCode
@AllArgsConstructor, @RequiredArgsConstructor and @NoArgsConstructor
@Log, @Log4j, @Log4j2, @Slf4j, @XSlf4j, @CommonsLog, @JBossLog, @Flogger, @CustomLog
@Data
@Builder
@SuperBuilder
@Singular
@以上是关于Mybatis配置解析以及日志的处理，分页的使用，使用注解开发，Lombok入门的主要内容，如果未能解决你的问题，请参考以下文章
Mybatis学习笔记：解析配置文件resultMap分页日志