Spring Boot：實(shí)現(xiàn)MyBatis分頁(yè)

合概述

想必大家都有過(guò)這樣的體驗(yàn)，在使用Mybatis時(shí)，最頭痛的就是寫(xiě)分頁(yè)了，需要先寫(xiě)一個(gè)查詢count的select語(yǔ)句，然后再寫(xiě)一個(gè)真正分頁(yè)查詢的語(yǔ)句，當(dāng)查詢條件多了之后，會(huì)發(fā)現(xiàn)真的不想花雙倍的時(shí)間寫(xiě) count 和 select，幸好我們有 pagehelper 分頁(yè)插件，pagehelper 是一個(gè)強(qiáng)大實(shí)用的 MyBatis 分頁(yè)插件，可以幫助我們快速的實(shí)現(xiàn)MyBatis分頁(yè)功能，而且pagehelper有個(gè)優(yōu)點(diǎn)是，分頁(yè)和Mapper.xml完全解耦，并以插件的形式實(shí)現(xiàn)，對(duì)Mybatis執(zhí)行的流程進(jìn)行了強(qiáng)化，這有效的避免了我們需要直接寫(xiě)分頁(yè)SQL語(yǔ)句來(lái)實(shí)現(xiàn)分頁(yè)功能。那么，接下來(lái)我們就來(lái)一起體驗(yàn)下吧。

實(shí)現(xiàn)案例

接下來(lái)，我們就通過(guò)實(shí)際案例來(lái)講解如何使用pagehelper來(lái)實(shí)現(xiàn)MyBatis分頁(yè)，為了避免重復(fù)篇幅，此篇教程的源碼基于《Spring Boot：整合MyBatis框架》一篇的源碼實(shí)現(xiàn)，讀者請(qǐng)先參考并根據(jù)教程鏈接先行獲取基礎(chǔ)源碼和數(shù)據(jù)庫(kù)內(nèi)容。

添加相關(guān)依賴(lài)

首先，我們需要在 pom.xml 文件中添加分頁(yè)插件依賴(lài)包。

pom.xml

<!-- pagehelper -->
<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper-spring-boot-starter</artifactId>
    <version>1.2.5</version>
</dependency>

添加相關(guān)配置

然后在 application.yml 配置文件中添加分頁(yè)插件有關(guān)的配置。

application.yml

# pagehelper   
pagehelper:
    helperDialect: mysql
    reasonable: true
    supportMethodsArguments: true
    params: count=countSql

編寫(xiě)分頁(yè)代碼

首先，在 DAO 層添加一個(gè)分頁(yè)查找方法。這個(gè)查詢方法跟查詢?nèi)繑?shù)據(jù)的方法除了名稱(chēng)幾乎一樣。

SysUserMapper.java

package com.louis.springboot.demo.dao;

import java.util.List;
import com.louis.springboot.demo.model.SysUser;

public interface SysUserMapper {
    int deleteByPrimaryKey(Long id);

    int insert(SysUser record);

    int insertSelective(SysUser record);

    SysUser selectByPrimaryKey(Long id);

    int updateByPrimaryKeySelective(SysUser record);

    int updateByPrimaryKey(SysUser record);
    
    /**
     * 查詢?nèi)坑脩?
     * @return
     */
    List<SysUser> selectAll();
    
    /**
     * 分頁(yè)查詢用戶
     * @return
     */
    List<SysUser> selectPage();
}

然后在 SysUserMapper.xml 中加入selectPage的實(shí)現(xiàn)，當(dāng)然你也可以直接用@Select注解將查詢語(yǔ)句直接寫(xiě)在DAO代碼，但我們這里選擇寫(xiě)在XML映射文件，這是一個(gè)普通的查找全部記錄的查詢語(yǔ)句，并不需要寫(xiě)分頁(yè)SQL，分頁(yè)插件會(huì)攔截查詢請(qǐng)求，并讀取前臺(tái)傳來(lái)的分頁(yè)查詢參數(shù)重新生成分頁(yè)查詢語(yǔ)句。

SysUserMapper.xml

<select id="selectPage"  resultMap="BaseResultMap">
  select 
  <include refid="Base_Column_List" />
  from sys_user
</select>

服務(wù)層通過(guò)調(diào)用DAO層代碼完成分頁(yè)查詢，這里統(tǒng)一封裝分頁(yè)查詢的請(qǐng)求和結(jié)果類(lèi)，從而避免因?yàn)樘鎿QORM框架而導(dǎo)致服務(wù)層、控制層的分頁(yè)接口也需要變動(dòng)的情況，替換ORM框架也不會(huì)影響服務(wù)層以上的分頁(yè)接口，起到了解耦的作用。

SysUserService.java

package com.louis.springboot.demo.service;
import java.util.List;
import com.louis.springboot.demo.model.SysUser;
import com.louis.springboot.demo.util.PageRequest;
import com.louis.springboot.demo.util.PageResult;

public interface SysUserService {

    /**
     * 根據(jù)用戶ID查找用戶
     * @param userId
     * @return
     */
    SysUser findByUserId(Long userId);

    /**
     * 查找所有用戶
     * @return
     */
    List<SysUser> findAll();

    /**
     * 分頁(yè)查詢接口
     * 這里統(tǒng)一封裝了分頁(yè)請(qǐng)求和結(jié)果，避免直接引入具體框架的分頁(yè)對(duì)象, 如MyBatis或JPA的分頁(yè)對(duì)象
     * 從而避免因?yàn)樘鎿QORM框架而導(dǎo)致服務(wù)層、控制層的分頁(yè)接口也需要變動(dòng)的情況，替換ORM框架也不會(huì)
     * 影響服務(wù)層以上的分頁(yè)接口，起到了解耦的作用
     * @param pageRequest 自定義，統(tǒng)一分頁(yè)查詢請(qǐng)求
     * @return PageResult 自定義，統(tǒng)一分頁(yè)查詢結(jié)果
     */
    PageResult findPage(PageRequest pageRequest);
}

服務(wù)實(shí)現(xiàn)類(lèi)通過(guò)調(diào)用分頁(yè)插件完成最終的分頁(yè)查詢，關(guān)鍵代碼是 PageHelper.startPage(pageNum, pageSize)，將前臺(tái)分頁(yè)查詢參數(shù)傳入并攔截MyBtis執(zhí)行實(shí)現(xiàn)分頁(yè)效果。

SysUserServiceImpl.java

package com.louis.springboot.demo.service.impl;
import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;
import com.louis.springboot.demo.dao.SysUserMapper;
import com.louis.springboot.demo.model.SysUser;
import com.louis.springboot.demo.service.SysUserService;
import com.louis.springboot.demo.util.PageRequest;
import com.louis.springboot.demo.util.PageResult;
import com.louis.springboot.demo.util.PageUtils;

@Service
public class SysUserServiceImpl implements SysUserService {
    
    @Autowired
    private SysUserMapper sysUserMapper;
    
    @Override
    public SysUser findByUserId(Long userId) {
        return sysUserMapper.selectByPrimaryKey(userId);
    }

    @Override
    public List<SysUser> findAll() {
        return sysUserMapper.selectAll();
    }
    
    @Override
    public PageResult findPage(PageRequest pageRequest) {
        return PageUtils.getPageResult(pageRequest, getPageInfo(pageRequest));
    }
    
    /**
     * 調(diào)用分頁(yè)插件完成分頁(yè)
     * @param pageQuery
     * @return
     */
    private PageInfo<SysUser> getPageInfo(PageRequest pageRequest) {
        int pageNum=pageRequest.getPageNum();
        int pageSize=pageRequest.getPageSize();
        PageHelper.startPage(pageNum, pageSize);
        List<SysUser> sysMenus=sysUserMapper.selectPage();
        return new PageInfo<SysUser>(sysMenus);
    }
}

在控制器SysUserController中添加分頁(yè)查詢方法，并調(diào)用服務(wù)層的分頁(yè)查詢方法。

SysUserController.java

package com.louis.springboot.demo.controller;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import com.louis.springboot.demo.service.SysUserService;
import com.louis.springboot.demo.util.PageRequest;

@RestController
@RequestMapping("user")
public class SysUserController {

    @Autowired
    private SysUserService sysUserService;
    
    @GetMapping(value="/findByUserId")
    public Object findByUserId(@RequestParam Long userId) {
        return sysUserService.findByUserId(userId);
    }
    
    @GetMapping(value="/findAll")
    public Object findAll() {
        return sysUserService.findAll();
    }
    
    @PostMapping(value="/findPage")
    public Object findPage(@RequestBody PageRequest pageQuery) {
        return sysUserService.findPage(pageQuery);
    }
}

分頁(yè)查詢請(qǐng)求封裝類(lèi)。

PageRequest.java

package com.louis.springboot.demo.util;
/**
 * 分頁(yè)請(qǐng)求
 */
public class PageRequest {
    /**
     * 當(dāng)前頁(yè)碼
     */
    private int pageNum;
    /**
     * 每頁(yè)數(shù)量
     */
    private int pageSize;
    
    public int getPageNum() {
        return pageNum;
    }
    public void setPageNum(int pageNum) {
        this.pageNum=pageNum;
    }
    public int getPageSize() {
        return pageSize;
    }
    public void setPageSize(int pageSize) {
        this.pageSize=pageSize;
    }
}

分頁(yè)查詢結(jié)果封裝類(lèi)。

PageResult.java

package com.louis.springboot.demo.util;
import java.util.List;
/**
 * 分頁(yè)返回結(jié)果
 */
public class PageResult {
    /**
     * 當(dāng)前頁(yè)碼
     */
    private int pageNum;
    /**
     * 每頁(yè)數(shù)量
     */
    private int pageSize;
    /**
     * 記錄總數(shù)
     */
    private long totalSize;
    /**
     * 頁(yè)碼總數(shù)
     */
    private int totalPages;
    /**
     * 數(shù)據(jù)模型
     */
    private List<?> content;
    public int getPageNum() {
        return pageNum;
    }
    public void setPageNum(int pageNum) {
        this.pageNum=pageNum;
    }
    public int getPageSize() {
        return pageSize;
    }
    public void setPageSize(int pageSize) {
        this.pageSize=pageSize;
    }
    public long getTotalSize() {
        return totalSize;
    }
    public void setTotalSize(long totalSize) {
        this.totalSize=totalSize;
    }
    public int getTotalPages() {
        return totalPages;
    }
    public void setTotalPages(int totalPages) {
        this.totalPages=totalPages;
    }
    public List<?> getContent() {
        return content;
    }
    public void setContent(List<?> content) {
        this.content=content;
    }
}

分頁(yè)查詢相關(guān)工具類(lèi)。

PageUtils.java

package com.louis.springboot.demo.util;
import com.github.pagehelper.PageInfo;

public class PageUtils {

    /**
     * 將分頁(yè)信息封裝到統(tǒng)一的接口
     * @param pageRequest 
     * @param page
     * @return
     */
    public static PageResult getPageResult(PageRequest pageRequest, PageInfo<?> pageInfo) {
        PageResult pageResult=new PageResult();
        pageResult.setPageNum(pageInfo.getPageNum());
        pageResult.setPageSize(pageInfo.getPageSize());
        pageResult.setTotalSize(pageInfo.getTotal());
        pageResult.setTotalPages(pageInfo.getPages());
        pageResult.setContent(pageInfo.getList());
        return pageResult;
    }
}

編譯測(cè)試運(yùn)行

啟動(dòng)應(yīng)用，訪問(wèn)：localhost:8088/swagger-ui.html，找到對(duì)應(yīng)接口，模擬測(cè)試，結(jié)果如下。

參數(shù)：pageNum: 1, pageSize: 5

參數(shù)：pageNum: 2, pageSize: 4

學(xué)習(xí)更多JAVA知識(shí)與技巧，關(guān)注與私信博主（學(xué)習(xí)）

yBatis開(kāi)發(fā)Dao有兩種方式：原始Dao的開(kāi)發(fā)方式，Mapper動(dòng)態(tài)代理的方式。

兩種開(kāi)發(fā)方式在企業(yè)開(kāi)發(fā)中均有運(yùn)用。都要掌握。

使用myBatis時(shí)，需要對(duì)其進(jìn)行一個(gè)全局的管理配置。

sqlMappingConfig.xml

[html] view plain copy

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<properties resource="db.properties"></properties>
<!-- 單個(gè)配置
type:類(lèi)型路徑
alias:別名-->
<!-- <typeAliases>
<typeAlias type="cn.edu.hpu.ssm.po.User" alias="user"/>
</typeAliases> -->
<!-- 批量設(shè)置(推薦使用)
指定包名，mybatis自動(dòng)掃描掃描po類(lèi)，自動(dòng)定義別名。默認(rèn)為類(lèi)名（首字母大寫(xiě)或小寫(xiě)） -->
<typeAliases>
<package name="cn.edu.hpu.ssm.po"/>
</typeAliases>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC" />
<dataSource type="POOLED">
<property name="driver" value="${jdbc.driver}" />
<property name="url" value="${jdbc.url}" />
<property name="username" value="${jdbc.username}" />
<property name="password" value="${jdbc.password}" />
</dataSource>
</environment>
</environments>
<!-- <mappers>
<mapper resource="sqlmap/User.xml"/>
<mapper resource="mapper/UserMapper.xml"/>
</mappers> -->
<!-- 通過(guò)mapper接口，加載映射文件
規(guī)范：mapper接口名必須與mapper。xml文件名相同，且放在同一包下
前提是使用mapper代理的方式 -->
<mappers>
<mapper class="cn.edu.hpu.ssm.mapper.UserMapper"/>
<mapper class="cn.edu.hpu.ssm.mapper.OrdersMapperCustom"/>
</mappers>
</configuration>

其中關(guān)于數(shù)據(jù)庫(kù)的一些配置，抽取出來(lái)了，這樣可以減少硬編碼：

db.properties：

[plain] view plain copy

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis
jdbc.username=root
jdbc.password=123456

1.原始Dao的開(kāi)發(fā)方式

原始Dao的開(kāi)發(fā)，需要程序員自己編寫(xiě)Dao的接口和Dao接口的實(shí)現(xiàn)類(lèi)。（一下以一個(gè)按照id查詢?yōu)槔f(shuō)明）

1.映射文件：

[html] view plain copy

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!-- namespace:命名空間，作用就是對(duì)sql進(jìn)行分類(lèi)化管理，sql隔離
注意：在使用mapper的代理方法開(kāi)發(fā)時(shí)，有重要作用 -->
<mapper namespace="test">
<!-- paramerType：指定輸入?yún)?shù)的類(lèi)型。
#{ } ：代表占位符。
#{id }：表示接受輸入?yún)?shù)id的值，如果輸入?yún)?shù)是簡(jiǎn)單類(lèi)型，#{ }中的參數(shù)名可以任意
，可以是value或是其他值
resultType：表示sql輸出結(jié)果的所映射的Javabean的對(duì)象類(lèi)型，resultType指定將單條記錄映射成Java對(duì)像-->
<select id="findUserById" parameterType="int" resultType="cn.edu.hpu.ssm.po.User">
SELECT * FROM USER WHERE id=#{value}
</select>
</mapper>

2.Dao接口：

[java] view plain copy

Public interface UserDao {
public User getUserById(int id) throws Exception;
}

3.Dao接口的實(shí)現(xiàn)

[java] view plain copy

Public class UserDaoImpl implements UserDao {
//通過(guò)構(gòu)造函數(shù)注入SqlSessionFactory
public UserDaoImpl(SqlSessionFactory sqlSessionFactory){
this.setSqlSessionFactory(sqlSessionFactory);
}
private SqlSessionFactory sqlSessionFactory;
@Override
public User getUserById(int id) throws Exception {
SqlSession session=sqlSessionFactory.openSession();
User user=null;
try {
//通過(guò)sqlsession調(diào)用selectOne方法獲取一條結(jié)果集
//參數(shù)1：指定定義的statement的id,參數(shù)2：指定向statement中傳遞的參數(shù)
user=session.selectOne("test.findUserById", 1);
System.out.println(user);
} finally{
session.close();
}
return user;
}
}

通過(guò)上面的例子，我們可以總結(jié)：

原始Dao開(kāi)發(fā)存在以下問(wèn)題：

Dao的方法存在重復(fù)代碼，：通過(guò)sqlSessionFactory創(chuàng)建SqlSession，調(diào)用sqlSession數(shù)據(jù)庫(kù)的操作方法。

調(diào)用sqlSession操作數(shù)據(jù)庫(kù)的方法（第一個(gè)參數(shù)）時(shí)，硬編碼，不利于系統(tǒng)的維護(hù)。

SqlSessionFactory的使用范圍：

通過(guò)SQLSessionFactoryBuilder創(chuàng)建會(huì)話工廠SQLSessionFactory。將SQLSessionFactoryBuilder當(dāng)做一個(gè)工具類(lèi)來(lái)使用即可，不需要使用單例模式去管理。

通過(guò)SQLSessionFactory創(chuàng)建sqlSession，使用單例模式管理SQLSessionFactory，（工廠一旦被創(chuàng)建，使用一個(gè)實(shí)例）。將來(lái)mybatis與spring整合后，使用單例模式來(lái)管理sqlSessionFactory。

sqlSession是線程不安全的，在sqlsession中不但存在操作數(shù)據(jù)庫(kù)的方法，還有數(shù)據(jù)域?qū)傩浴qlSession最佳應(yīng)用場(chǎng)合，是在方法體內(nèi)，定義成局部變量使用。

2.Mapper代理的方式：

mapper動(dòng)態(tài)代理實(shí)現(xiàn)的原理：

mapper接口開(kāi)發(fā)方式，只需要程序員編寫(xiě)mapper接口（相當(dāng)于Dao接口），有mybatis框架根據(jù)接口定義創(chuàng)建接口的動(dòng)態(tài)代理對(duì)象，代理的方法體與上面Dao實(shí)現(xiàn)類(lèi)中的方法體相類(lèi)似

Mapper接口開(kāi)發(fā)要符合一下規(guī)范：

1.Mapper.xml中namespace路徑與mapper接口路徑相同

2.mapper接口中的方法名，與Mapper.xml中對(duì)應(yīng)statement的id相同

3.mapper接口中方法的輸入?yún)?shù)類(lèi)型和mapper.xml中定義的對(duì)應(yīng)sql的ParameterType的類(lèi)型相同

4.mapper接口中方法的返回值類(lèi)型和mapper.xml中定義的對(duì)應(yīng)sql的ResultType的類(lèi)型相同

1.Mapper.xml寫(xiě)法：（與上面User.xml不同的是namespace做了定義）

[html] view plain copy

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!-- namespace:命名空間，作用就是對(duì)sql進(jìn)行分類(lèi)化管理，sql隔離
注意：在使用mapper的代理方法開(kāi)發(fā)時(shí)，有重要作用
namespace命名必須與Mapper接口的路徑相同 -->
<mapper namespace="cn.edu.hpu.ssm.mapper.UserMapper">
<!-- paramerType：指定輸入?yún)?shù)的類(lèi)型。
#{ } ：代表占位符。
#{id }：表示接受輸入?yún)?shù)id的值，如果輸入?yún)?shù)是簡(jiǎn)單類(lèi)型，#{ }中的參數(shù)名可以任意
，可以是value或是其他值
resultType：表示sql輸出結(jié)果的所映射的Javabean的對(duì)象類(lèi)型，resultType指定將單條記錄映射成Java對(duì)像-->
<select id="findUserById" parameterType="int" resultType="User">
SELECT * FROM USER WHERE id=#{value}
</select>
</mapper>

2.mapper.java（接口文件）

[java] view plain copy

package cn.edu.hpu.ssm.mapper;
import java.util.List;
import java.util.Map;
import cn.edu.hpu.ssm.po.User;
import cn.edu.hpu.ssm.po.UserCustom;
import cn.edu.hpu.ssm.po.UserQueryVo;
public interface UserMapper {
//返回值類(lèi)型必須與mapper.xml中resultType類(lèi)型相同
//形參必須與mapper.xml中的parameterType類(lèi)型相同
//mapper.java接口中的方法名和mapper.xml中statement的id一致
public User findUserById(int id) throws Exception;
}

3.測(cè)試文件：（通過(guò)junit）

[java] view plain copy

public class MapperTest {

[java] view plain copy

private SqlSessionFactory sqlSessionFactory;
@Before
public void setUp() throws Exception {
String resource="SqlMapConfig.xml";
InputStream input=Resources.getResourceAsStream(resource);
sqlSessionFactory=new SqlSessionFactoryBuilder().build(input);
}

[java] view plain copy

/**
* 通過(guò)id查詢
* @throws Exception
*/
@Test
public void testFindUserById() throws Exception {
SqlSession session=sqlSessionFactory.openSession();
//通過(guò)session自動(dòng)創(chuàng)建mapper代理對(duì)象
UserMapper userMap=session.getMapper(UserMapper.class);
User user=userMap.findUserById(1);
System.out.println(user);
}

[java] view plain copy

}

4.對(duì)Mapper動(dòng)態(tài)代理的一個(gè)小結(jié)：

1.使用mapper代理時(shí)，輸入?yún)?shù)類(lèi)型可以使用pojo的包裝對(duì)象，或是mapper對(duì)象，保證dao的同性。

2.selectOne和selectList

動(dòng)態(tài)代理對(duì)象通過(guò)sqlsession.selectOne和sqlsession.selectList，是通過(guò)對(duì)返回值類(lèi)型進(jìn)行判斷而選擇調(diào)用哪一個(gè)方法。如果返回單個(gè)對(duì)象則調(diào)用selectOne，返回集合對(duì)象則調(diào)用selectList

積月累，方成大器。

各大網(wǎng)站：

Mybatis官方技術(shù)文檔 https://mybatis.org/mybatis-3/zh/index.html
Mybatis源碼包下載：https://github.com/mybatis/mybatis-3/releases
所有代碼及筆記gitee路徑：https://gitee.com/simple-coding/all-demo-code.git

一、關(guān)于Mybatis開(kāi)發(fā)

要使用Mybatis開(kāi)發(fā)只需引入mybatis-x.x.x.jar即可，想其它的日志等，如果需要可以另外引入包進(jìn)行擴(kuò)展。

本案例使用最新版本：mybatis-3.5.9.jar

二、日志配置

如果我們不引入第三方的日志包，那mybatis就不能對(duì)日志進(jìn)行輸出了嗎？

首先，要知道Mybatis不引入第三方日志包，也能進(jìn)行日志輸出(默認(rèn)日志功能禁用)，只不過(guò)只能進(jìn)行控制臺(tái)輸出，不能進(jìn)行文件輸出；另外，對(duì)于第三方日志，mybatis有特定的加載順序，如果引入了多個(gè)日志實(shí)現(xiàn)也可以在主配置中通過(guò)settings進(jìn)行配置，告訴mybatis我要用哪個(gè)進(jìn)行輸出。

最新版本，第三方加載順序如下、源碼如下圖（不同的mybatis版本可能不一樣）：

SLF4J
Apache Commons Logging
Log4j 2
Log4j (deprecated since 3.5.9)
JDK logging

MyBatis 內(nèi)置日志工廠基于運(yùn)行時(shí)自省機(jī)制選擇合適的日志工具。它會(huì)使用第一個(gè)查找得到的工具（按上文列舉的順序查找）。如果一個(gè)都未找到，日志功能就會(huì)被禁用。

Mybatis日志加載順序

三、Mybatis支持哪些日志

Mybatis支持哪些日志的配置，那就要看我們的主配置文件中settings配置了，配置如下

日志實(shí)現(xiàn)指定

說(shuō)白了就是支持常用實(shí)現(xiàn)JUL（java util logging）、logback、log4j、log4j2，而SLF4J和COMMONS_LOGGING其實(shí)就是日志門(mén)面技術(shù)，也就是接口。關(guān)于日志框架我們后續(xù)，會(huì)單獨(dú)講一下。

四、日志演示

1.STDOUT_LOGGING

STDOUT_LOGGING ：是Mybatis內(nèi)置實(shí)現(xiàn)，只做控制臺(tái)輸出。配置只需一步，也不需要引入第三方依賴(lài)：

指定settings配置

<setting name="logImpl" value="STDOUT_LOGGING"/>

效果圖

運(yùn)行結(jié)果

2.SLF4J

首先聲明SLF4J是日志門(mén)面技術(shù)，通過(guò)一系列中間轉(zhuǎn)換操作，可以適配現(xiàn)有的任何日志技術(shù)。本節(jié)只做簡(jiǎn)單的配置實(shí)現(xiàn)logback。

引入第三方包

<!--這個(gè)依賴(lài)直接包含了 logback-core實(shí)現(xiàn) 以及 slf4j-api日志門(mén)面的依賴(lài)-->
<dependency>
		<groupId>ch.qos.logback</groupId>
		<artifactId>logback-classic</artifactId>
		<version>1.2.11</version>
</dependency>

指定settings配置

不配置也行，第三方日志只有一個(gè)日志實(shí)現(xiàn)的情況下，有默認(rèn)加載順序，詳見(jiàn)：第二部分、日志配置

<!--使用logback-->
<setting name="logImpl" value="SLF4J"/>

引入logback配置文件：logback.xml

開(kāi)啟debug級(jí)別，用于輸出SQL語(yǔ)句。

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
    <!--定義日志文件的存儲(chǔ)地址 勿在 LogBack 的配置中使用相對(duì)路徑-->
    <property name="LOG_HOME" value="logs"/>
    <!-- 控制臺(tái)輸出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級(jí)別從左顯示5個(gè)字符寬度%msg：日志消息，%n是換行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
    </appender>
    <!-- 按照每天生成日志文件 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!--日志文件輸出的文件名-->
            <fileNamePattern>${LOG_HOME}/%d{yyyy-MM-dd}/smifc.log.%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <maxFileSize>10MB</maxFileSize>
            <maxHistory>20</maxHistory>
            <totalSizeCap>100GB</totalSizeCap>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級(jí)別從左顯示5個(gè)字符寬度%msg：日志消息，%n是換行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
    </appender>
    <!-- 日志輸出級(jí)別 -->
    <root level="DEBUG">
        <appender-ref ref="STDOUT"/>
    </root>
    <root level="DEBUG">
        <appender-ref ref="FILE"/>
    </root>
</configuration>

效果圖

logback

3.JDK_LOGGING

JDK_LOGGING是個(gè)啥？其實(shí)它就是JDK自帶的日志。也不需要我們引入第三方包。

jdk自帶的日志，配置文件加載有三種方法：1.默認(rèn)路徑【JRE_HOME/lib/logging.properties】；2.自定義加載配置文件路徑【java.util.logging.config.file】；3.自定義加載配置類(lèi)【java.util.logging.config.class】需要通過(guò)readConfiguration(InputStream) 實(shí)現(xiàn)

看下JDK源碼LogManager加載配置實(shí)現(xiàn)：

JDK源碼LogManager加載配置實(shí)現(xiàn)

自定義加載配置文件路徑【java.util.logging.config.file】實(shí)現(xiàn)

自定義加載路徑

引入logging.properties

handlers=java.util.logging.ConsoleHandler
.level=ALL

#mapper的命名空間
test=ALL

java.util.logging.ConsoleHandler.level=ALL
java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter
java.util.logging.SimpleFormatter.format=%1$tT.%1$tL %4$s %3$s - %5$s%6$s%n

主配置文件指定日志實(shí)現(xiàn)

<setting name="logImpl" value="JDK_LOGGING"/>

效果圖

運(yùn)行結(jié)果

4.LOG4J、LOG4J2

LOG4J(log4j.properties)、LOG4J2(log4j2.xml)這兩個(gè)實(shí)現(xiàn)和logback實(shí)現(xiàn)大同小異，直接引入實(shí)現(xiàn)jar包，變更主配置實(shí)現(xiàn)即可。

jar包引入

引入jar包

主配置配置

指定日志實(shí)現(xiàn)

配置文件

配置文件

運(yùn)行結(jié)果

運(yùn)行結(jié)果

5.COMMONS_LOGGING

COMMONS_LOGGING (commons-logging.properties)是一個(gè)日志門(mén)面技術(shù)，也就是接口，其自身自帶簡(jiǎn)單實(shí)現(xiàn)org.apache.commons.logging.impl.SimpleLog也支持jdk的日志實(shí)現(xiàn)。這里我們引入commons-logging包使用其的簡(jiǎn)單日志實(shí)現(xiàn)。

另外，支持的實(shí)現(xiàn)如下：

 //LogFactoryImpl.java
 private static final String[] classesToDiscover=new String[]{"org.apache.commons.logging.impl.Log4JLogger", "org.apache.commons.logging.impl.Jdk14Logger", "org.apache.commons.logging.impl.Jdk13LumberjackLogger", "org.apache.commons.logging.impl.SimpleLog"};

只引入commons-logging包

<!--commons-logging-->
<dependency>
 <groupId>commons-logging</groupId>
 <artifactId>commons-logging</artifactId>
 <version>1.2</version>
</dependency>

定義commons-logging.properties指明使用的日志實(shí)現(xiàn)

org.apache.commons.logging.Log=org.apache.commons.logging.impl.SimpleLog

定義simplelog.properties配置日志信息

org.apache.commons.logging.simplelog.defaultlog=all
org.apache.commons.logging.simplelog.log.test=all
org.apache.commons.logging.simplelog.showlogname=true
org.apache.commons.logging.simplelog.showShortLogname=true
org.apache.commons.logging.simplelog.showdatetime=true
org.apache.commons.logging.simplelog.dateTimeFormat=yyyy-MM-dd hh:mm:ss

主配置指定實(shí)現(xiàn)

<!--使用COMMONS_LOGGING簡(jiǎn)單日志-->
<setting name="logImpl" value="COMMONS_LOGGING"/>

效果

運(yùn)行結(jié)果

五、總結(jié)

在以上的日志配置中，我引入了所有的日志實(shí)現(xiàn)，通過(guò)控制主配置文件中配置

 <setting name="logImpl" value="XXX"/>

達(dá)到，具體要使用哪個(gè)的目的。如果整合Mybatis時(shí)有多個(gè)日志實(shí)現(xiàn)，可通過(guò)此配置控制。

在線咨詢

上一篇：「轉(zhuǎn)行測(cè)試開(kāi)發(fā)-HTML」(三)上次沒(méi)說(shuō)完的標(biāo)題、段
下一篇：HTML5之canves繪圖

您的項(xiàng)目需求

*請(qǐng)認(rèn)真填寫(xiě)需求信息，我們會(huì)在24小時(shí)內(nèi)與您取得聯(lián)系。

整合營(yíng)銷(xiāo)服務(wù)商

Spring Boot：實(shí)現(xiàn)MyBatis分頁(yè)

合概述

實(shí)現(xiàn)案例

添加相關(guān)依賴(lài)

添加相關(guān)配置

編寫(xiě)分頁(yè)代碼

編譯測(cè)試運(yùn)行

一、關(guān)于Mybatis開(kāi)發(fā)

二、日志配置

三、Mybatis支持哪些日志

四、日志演示

1.STDOUT_LOGGING

2.SLF4J

3.JDK_LOGGING

4.LOG4J、LOG4J2

5.COMMONS_LOGGING

五、總結(jié)

您的項(xiàng)目需求