Spring boot 添加日志 和 生成接口文档

时间：2022-12-14 19:27:53
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

上述jar包中，已经有关于logging的定义了
 用的时候，直接添加记录器
// 记录器
Logger logger = LoggerFactory.getLogger(getClass());

日志的级别；
由低到高 trace < debug < info < warn < error
可以调整需要输出的日志级别；日志只会在这个级别和以后的高级别生效


@Test
public void contextLoads() {

    logger.trace("这是trace日志...");
    logger.debug("这是debug日志...");
    logger.info("这是info日志...");
    logger.warn("这是warn日志...");
    logger.error("这是error日志...");
}

如果想在输出格式中定义时间或者格式：
需要在application.properties中添加
logging.level.com.atguigu=trace
# logging.path
# 当前项目下生成springboot.log日志
# 可以指定完整的路径；
#logging.file=E:/springboot.log

# 在当前磁盘的根路径下创建spring.log作为默认文件
logging.path=./Logs
# 上面一行logging.path将不起效了
logging.file=./Logs/aaa.log

# 在控制台输出的日志格式
logging.pattern.console=%d{yyyyMMdd hh:mm:ss} [%thread] %-5level %logger{50} - %msg%n
# 指定文件中日志输出的格式
logging.pattern.file=%d{yyyyMMdd hh:mm:ss} === [%thread] === %-5level === %logger{50} === - %msg%n


更多的日志介绍，可配置在logback.xml中


生成接口文档
通常情况是，都是现有接口文档，在进行开发工作，所以之前我们会有word版本，或者其他工具作为文档
现在，有一些简单的插件，可以让接口文档自动生成了
1. 前篇随笔中介绍的Swagger2   链接直达：  https://www.cnblogs.com/qianjinyan/p/6635480.html
2. apidoc生成



如何生成apicod
1. 安装node.js, 链接 https://nodejs.org/en/ 我用的windows系统，下载了node-v11.5.0-x64.msi， 双机安装
2. 使用npm安装apidoc  
在终端输入 npm install apidoc –g
3. 编写apidoc文档
在Controller中的方法上面编写apidoc文档，内容如下：
4. 在pom.xml同一级下，创建package.json文件
package.json 文件内容：

{
"name": "测试api文档",
"version": "0.1.0",
"description": "这只是一个测试的页面",
"title": "APIDOC 测试",
"url" : "https://127.0.0.1:8080/",
"sampleUrl":"https://127.0.0.1:8080/"
}



5. apidoc -i apiTestDemo/ -o apidocDemo/

apidoc 和 swagger不同的是，接口文档和代码文件都是分开的。一开始只需要专心编写接口代码，当代码编写完成时，只需在方法上加上指定的注释。（到这里，也就是我上述所描述的内容）。最终通过一段命令执行生成最终的html文档。
回归正题，在准备工作中我们已经安装了apidoc，然后我们通过apidoc命令生成文档：

截图以后附上

标签：

相关文章