【MyBatis从入门到入土】4 - 日志和分页

7 日志

7.1 日志

我们在【MyBatis从入门到入土】2 - MyBatis配置、生命周期作用域这篇博客中详细讲解了对于mybatis-config.xml中的各项配置，其中在setting项的调整配置中，我们提到了logImpl，但没有深入，这次我们来展开讲解。
可以看到MyBatis支持了如下的日志工具

• SLF4J
• LOG4J 【掌握】
• LOG4J2
• JDK_LOGGING
• COMMONS_LOGGING
• STDOUT_LOGGING【掌握】

我们在mybatis-config.xml文件中添加如下配置，表示使用STDOUT_LOGGING工具类：

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

接着我们调用通过id查询User的测试方法，控制台打印输出：

我们来对比一下没有使用日志工具的控制台打印输出：

7.2 Log4J

在上一节我们可以看到，对于日志工具STDOUT_LOGGING可以直接使用，但LOG4J日志工具我们需要额外的工作才能使用。

• 什么是Log4J
  Log4J大名鼎鼎，但我们首先还是来了解一下Log4J。Log4J是Log for Java的缩写，根据百度百科的定义：

Log4j是Apache的一个开源项目，通过使用Log4j，

• 我们可以控制日志信息输送的目的地是控制台、文件、GUI组件，甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等；
• 我们也可以控制每一条日志的输出格式；
• 通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。
• 最令人感兴趣的就是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。

• MyBatis中使用Log4J

1. 修改settings中的logImpl

    <settings>
        <setting name="logImpl" value="LOG4J"/>
    </settings>

2. 在pom.xml中导入Log4J的依赖

        <!-- https://mvnrepository.com/artifact/log4j/log4j -->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>

3. 在resources添加配置文件log4j.properties，该配置文件含有各项log4j的各项详细配置，需要详细了解的话可以查看log4j的百度百科，这里给出一般通用的配置：

#将等级为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/cap.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

4. 接下来编写一个测试类，测试运行

public class Log4jTest {

    Logger logger = Logger.getLogger(Log4jTest.class);

    @Test
    public void test(){
        logger.info("info#########");
        logger.debug("debug#######");
        logger.error("error#######");
    }
}

得益于我们刚才log4j.properties配置，在项目下生成了相应的日志文件
可以看到cap.log文件中生成了相应的日志

[INFO][20-07-05][com.cap.utils.dao.Log4jTest]info#########
[DEBUG][20-07-05][com.cap.utils.dao.Log4jTest]debug#######
[ERROR][20-07-05][com.cap.utils.dao.Log4jTest]error#######

8 分页

我们使用SELECT查询表中数据得到庞大的数据量时，通常会考虑使用LIMIT来对进行分页。下面讲解一下LIMIT语法的使用：

SELECT * FROM table_name 
LIMIT startIndex, pageSize;

startIndex：起始索引值，未显式指定的话默认为0
pageSize：记录数目
举个栗子，查询user表中从第0条记录开始，最多展现两条记录

SELECT * FROM user
LIMIT 2; # 等价于 LIMIT 0,2

那么在MyBatis中如何实现分页呢？接下来介绍三种方式，重点掌握第一种方式！

8.1 利用SQL

1. 首先在UserMapping接口编写一个分页查询方法

    /**
     * <p>查询所有用户，但可以使用分页</p>
     * @param startIndex
     * @param pageSize
     * @return
     */
    List<User> getUsersByLimit(int startIndex, int pageSize);
    

2. 接着在UserMapping.xml配置文件中添加相应SQL语句，注意这里我们使用resultMap来将user表中的字段名和我们实体类的属性名关联起来，另外由于getUserByLimit()方法的参数列表有多个，我们使用arg0、arg1分别表示第一个参数、第二个参数（当然也可以使用param1、param2）

<mapper namespace="com.cap.dao.UserMapping">

    <resultMap id="userResultMap" type="user">
        <result column="user_id" property="id" />
        <result column="user_name" property="name" />
        <result column="user_pwd" property="pwd" />
    </resultMap>
    
    <select id="getUsersByLimit" resultMap="userResultMap">
        SELECT *
        FROM user
        LIMIT #{arg0}, #{arg1};
    </select>
    
</mapper>

3. 编写测试方法

   @Test
   public void testGetUsersByLimit(){
       SqlSession sqlSession = MyBatisUtil.getSqlSession();
       UserMapping mapper = sqlSession.getMapper(UserMapping.class);

       List<User> userList = mapper.getUsersByLimit(0, 4);

       userList.forEach(System.out::println);

       sqlSession.close();
   }
   /**OUTPUT
    User{id=1, name='狂神', pwd='123456'}
	User{id=2, name='张三', pwd='123456'}
	User{id=3, name='李四', pwd='123456'}
	User{id=4, name='赵子龙', pwd='123456'}
*/

8.2 使用RowBound类——不推荐使用，了解即可

这种充分利用了面向对象的思想，但这种方式效率还不如上一种方式来得快

1. 在UserMapping接口中创建一个相应的方法

    /**
     * <p>使用RowBound来实现分页查询</p>
     * @return
     */
    List<User> getUsersByRowBound();

2. 在UserMapping.xml中添加一个简单的SQL查询

    <select id="getUsersByRowBound" resultMap="userResultMap">
        SELECT *
        FROM user;
    </select>

3. 编写测试方法

    @Test
    public void testGetUsersByRowBound(){
        SqlSession sqlSession = MyBatisUtil.getSqlSession();

        RowBounds rowBounds = new RowBounds(1, 2);

        List<Object> userList = sqlSession.selectList("com.cap.dao.UserMapping.getUsersByRowBound", null, rowBounds);

        userList.forEach(System.out::println);

        sqlSession.close();
    }
    /**
    User{id=2, name='张三', pwd='123456'}
	User{id=3, name='李四', pwd='123456'}
	*/

8.3 利用pageHelper插件

PageHelper官方网站对于如何使用该插件有详细的文档，这里不展开说明，需要使用的话请查看官方文档。