单元测试 & 日志简明笔记

发表于 更新于 本文字数： 4.9k 阅读时长 ≈ 4 分钟

单元测试

JUnit 是一个 Java 编程语言的单元测试工具。JUnit 是一个非常重要的测试工具

JUnit 在一个条中显示进度。如果运行良好则是绿色；如果运行失败，则变成红色

使用步骤

  1. 将 junit 的 jar 包导入到工程中 junit-4.9.jar
  2. 编写测试方法该测试方法必须是公共的无参数无返回值的非静态方法
  3. 在测试方法上使用 @Test 注解标注该方法是一个测试方法
  4. 选中测试方法右键通过 junit 运行该方法

代码示例

1
2
3
4
5
6
7
8
9
10
public class JunitDemo1 {
    @Test
    public void add() {
        System.out.println(2 / 0);
        int a = 10;
        int b = 20;
        int sum = a + b;
        System.out.println(sum);
    }
}

相关注解

  • @Test：表示测试该方法
  • @Before：在测试的方法前运行
  • @After：在测试的方法后运行

日志

程序中的日志可以用来记录程序在运行的时候点点滴滴，并可以进行永久存储

日志与输出语句的区别

输出语句 日志技术
取消日志 需要修改代码，灵活性比较差 不需要修改代码，灵活性比较好
输出位置 只能是控制台 可以将日志信息写入到文件或者数据库中
多线程 和业务代码处于一个线程中 多线程方式记录日志，不影响业务代码的性能

日志体系结构

01-日志的体系结构.png

Log4J

Log4j 是 Apache 的一个开源项目；通过使用 Log4j，我们可以控制日志信息输送的目的地是控制台、文件等位置，我们也可以控制每一条日志的输出格式，通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程

最令人感兴趣的就是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码

入门案例

  1. 导入 log4j 的相关 jar 包
  2. 编写 log4j 配置文件
  3. 在代码中获取日志的对象
  4. 按照级别设置记录日志信息

1、properties 文件

注意：配置文件的文件名必须是 log4j.properties，放在 src 目录下

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// log4j的配置文件,名字为log4j.properties, 放在src根目录下
log4j.rootLogger=debug,my,fileAppender

### direct log messages to my ###
log4j.appender.my=org.apache.log4j.ConsoleAppender
log4j.appender.my.ImmediateFlush = true
log4j.appender.my.Target=System.out
log4j.appender.my.layout=org.apache.log4j.PatternLayout
log4j.appender.my.layout.ConversionPattern=%d %t %5p %c{1}:%L - %m%n

# fileAppender演示
log4j.appender.fileAppender=org.apache.log4j.FileAppender
log4j.appender.fileAppender.ImmediateFlush = true
log4j.appender.fileAppender.Append=true
log4j.appender.fileAppender.File=D:/log4j-log.log
log4j.appender.fileAppender.layout=org.apache.log4j.PatternLayout
log4j.appender.fileAppender.layout.ConversionPattern=%d %5p %c{1}:%L - %m%n

2、测试类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
public class Log4JTest01 {
    //方式1：使用log4j的api来获取日志的对象
    //弊端：如果以后我们更换日志的实现类，那么下面的代码就需要跟着改
    //不推荐使用
    //private static final Logger LOGGER = Logger.getLogger(Log4JTest01.class);

    //方式2：使用slf4j里面的api来获取日志的对象
    //好处：如果以后我们更换日志的实现类，那么下面的代码不需要跟着修改
    //推荐使用（在代码中获取日志的对象）
    private static final Logger LOGGER = LoggerFactory.getLogger(Log4JTest01.class);

    public static void main(String[] args) {
        //1.导入jar包
        //2.编写配置文件
        //3.在代码中获取日志的对象
        //4.按照日志级别设置日志信息
        LOGGER.debug("debug级别的日志");
        LOGGER.info("info级别的日志");
        LOGGER.warn("warn级别的日志");
        LOGGER.error("error级别的日志");
    }
}

配置文件详解

三个核心

  • Loggers (记录器) ：日志的级别
    • Loggers 组件在此系统中常见的五个级别：DEBUG、INFO、WARN、ERROR 和 FATAL
    • DEBUG < INFO < WARN < ERROR < FATAL
    • Log4j 有一个规则：只输出级别不低于设定级别的日志信息
  • Appenders (输出源)：日志要输出的地方
    • 把日志输出到不同的地方，如控制台（Console）、文件（Files）等
    • org.apache.log4j.ConsoleAppender（控制台）
    • org.apache.log4j.FileAppender（文件）
  • Layouts (布局)：日志输出的格式
    • org.apache.log4j.PatternLayout（可以灵活地指定布局模式，这个比较常用）
    • org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串）
    • org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等信息）
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// log4j的配置文件,名字为log4j.properties, 放在src根目录下
log4j.rootLogger=debug,my,fileAppender

### direct log messages to my ###
log4j.appender.my=org.apache.log4j.ConsoleAppender
log4j.appender.my.ImmediateFlush = true
log4j.appender.my.Target=System.out
log4j.appender.my.layout=org.apache.log4j.PatternLayout
log4j.appender.my.layout.ConversionPattern=%d %t %5p %c{1}:%L - %m%n

# fileAppender演示
log4j.appender.fileAppender=org.apache.log4j.FileAppender
log4j.appender.fileAppender.ImmediateFlush = true
log4j.appender.fileAppender.Append=true
log4j.appender.fileAppender.File=D:/log4j-log.log
log4j.appender.fileAppender.layout=org.apache.log4j.PatternLayout
log4j.appender.fileAppender.layout.ConversionPattern=%d %5p %c{1}:%L - %m%n

1、配置根 Logger

1
2
3
4
log4j.rootLogger=日志级别，appenderName1，appenderName2，…

# 日志级别：OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别
# appenderName1：就是指定日志信息要输出到哪里。可以同时指定多个输出目的地，用逗号隔开

2、ConsoleAppender 常用的选项

1
2
3
log4j.appender.my=org.apache.log4j.ConsoleAppender
log4j.appender.my.ImmediateFlush = true
log4j.appender.my.Target=System.out
  • 第一句表示往控制台输出
  • 第二句表示所有消息都会被立即输出，设为 false 则不输出，默认值是 true
  • 第三句默认值是 System.out
    • 比如 System.err 打印出来是红色的

3、FileAppender 常用的选项

1
2
3
4
log4j.appender.fileAppender=org.apache.log4j.FileAppender
log4j.appender.fileAppender.ImmediateFlush = true
log4j.appender.fileAppender.Append=true
log4j.appender.fileAppender.File=D:/log4j-log.log
  • 第一句：往文件中输出
  • 第二句：表示所有消息都会被立即输出。设为 false 则不输出，默认值是 true
  • 第三句：true 表示将消息添加到指定文件中，原来的消息不覆盖，默认值是 true
  • 第四句：指定消息输出到某个文件中

4、PatternLayout 常用的选项

  • org.apache.log4j.PatternLayout（可以灵活地指定布局模式，最常用）
  • org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串）
  • org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等信息）

这里我们只讲第一种：PatternLayout 的常用选项

02-日志中PatternLayout的常用选项.png

在项目中的应用

  1. 导入相关的依赖
  2. 将资料中的 properties 配置文件复制到 src 目录下
  3. 在代码中获取日志的对象
  4. 按照级别设置记录日志信息

代码实现

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
@WebServlet(urlPatterns = "/servlet/loginservlet")
public class LoginServlet implements HttpServlet{

    //获取日志的对象
    private static final Logger LOGGER = LoggerFactory.getLogger(LoginServlet.class);

    @Override
    public void service(HttpRequest httpRequest, HttpResponse httpResponse) {
       //处理
        System.out.println("LoginServlet处理了登录请求");

        LOGGER.info("现在已经处理了登录请求，准备给浏览器响应");

       //响应
        httpResponse.setContentTpye("text/html;charset=UTF-8");
        httpResponse.write("登录成功");
    }
}

注意：Logger 对象是 slf4j (org.slf4jh) 中的，不要导错包了