建站笔记（三）
框架搭建
一、构建SpringBoot框架
1.使用idea快速搭建SpringBoot框架
使用idea新建项目，这里使用的是jdk1.8，选择相应组件，这里选择如下，点击下一个，选择保存路径创建好项目
创建好项目后，很根据刚选择的组件自动添加依赖，当然，这里只有我们需要的一部分，还有一些依赖要用到的依赖如下，打开pom.xml文件，添加以下代码
<!--AOP进行日志处理-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<!--引入markdown插件-->
<dependency>
<groupId>com.atlassian.commonmark</groupId>
<artifactId>commonmark</artifactId>
<version>0.10.0</version>
</dependency>
<!--引入markdown插件-->
<dependency>
<groupId>com.atlassian.commonmark</groupId>
<artifactId>commonmark-ext-heading-anchor</artifactId>
<version>0.10.0</version>
</dependency>
<!--引入markdown插件-->
<dependency>
<groupId>com.atlassian.commonmark</groupId>
<artifactId>commonmark-ext-gfm-tables</artifactId>
<version>0.10.0</version>
</dependency>
<!--引入分页插件-->
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper-spring-boot-starter</artifactId>
<version>1.2.12</version>
</dependency>
2.配置yml文件
创建好SpringBoot项目后，框架自带的是properties文件，这里使用yml文件进行配置，所以将application.properties改为application.yml文件，并进行相关配置。 我们在开发项目的时候，一般开发环境和部署环境会不一样，为了加以区分，可以在yml配置文件中体现出来，所以分为application-dev.yml(开发环境)、application-pro.yml(部署环境)，而为了能够让SpringBoot知道用的是哪个配置文件，需要在application.yml配置文件中加以说明，并且开发和部署中相同的配置也可以在application.yml中进行配置，详细配置如下：
- application.yml：公共配置和表明当前配置文件
- application-dev.yml：开发环境配置文件
- application-pro.yml：部署环境配置文件
application.yml
spring:
thymeleaf:
mode: HTML
profiles:
active: dev
messages:
basename: i18n/messages
comment.avatar: /images/avatar.png
message.avatar: /images/avatar.png
application-dev.yml
spring:
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/myblog?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=UTC
username: root
password: 66666
logging:
level:
root: info
com.cbx: debug
file: log/blog-dev.log
mybatis:
type-aliases-package: com.cbx.entity
mapper-locations: classpath:mapper/*.xml
configuration:
map-underscore-to-camel-case: true
pagehelper:
auto-dialect: mysql
params: count=countSql
reasonable: true
support-methods-arguments: true
application-pro.yml
spring:
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/myblog?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=UTC
username: root
password: 66666
logging:
level:
root: warn
com.cbx: info
file: log/blog-pro.log
mybatis:
type-aliases-package: com.cbx.entity
mapper-locations: classpath:mapper/*.xml
configuration:
map-underscore-to-camel-case: true
pagehelper:
auto-dialect: mysql
params: count=countSql
reasonable: true
support-methods-arguments: true
logging.level设置日志级别，后面跟生效的区域，比如root表示整个项目，也可以设置为某个包下，也可以具体到某个类名（日志级别的值不区分大小写）
logging.level.root=info就是默认的情况,默认打印info及其以上级别的日志
logging.level.root=warn时，项目已成功启动，只是没有warn级别的日志而已
在上面的配置中，可以看到，公共部分application.yml配置了thymeleaf模板、当前配置活跃文件、数据持久层的配置，开发环境和部署环境配置了数据库（两个环境的数据库用户名和密码一般会不一样），然后就是日志文件的相关配置，可以在指定文件夹下生成日志文件。
SpringBoot中有日志默认的生成以及切分，在这里我们可以重写SpringBoot默认日志配置，自定义日志大小和名称等等，在资源文件夹下添加logback-spring.xml进行配置，配置如下：
<?xml version="1.0" encoding="UTF-8" ?>
<configuration>
<!--包含Spring boot对logback日志的默认配置-->
<include resource="org/springframework/boot/logging/logback/defaults.xml" />
<property name="LOG_FILE" value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}}/spring.log}"/>
<include resource="org/springframework/boot/logging/logback/console-appender.xml" />
<!--重写了Spring Boot框架 org/springframework/boot/logging/logback/file-appender.xml 配置-->
<appender name="TIME_FILE"
class="ch.qos.logback.core.rolling.RollingFileAppender">
<encoder>
<pattern>${FILE_LOG_PATTERN}</pattern>
</encoder>
<file>${LOG_FILE}</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_FILE}.%d{yyyy-MM-dd}.%i</fileNamePattern>
<!--保留历史日志一个月的时间-->
<maxHistory>30</maxHistory>
<!--
Spring Boot默认情况下，日志文件10M时，会切分日志文件,这样设置日志文件会在100M时切分日志
-->
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>10MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
</appender>
<root level="INFO">
<appender-ref ref="CONSOLE" />
<appender-ref ref="TIME_FILE" />
</root>
</configuration>
<!--
1、继承Spring boot logback设置（可以在appliaction.yml或者application.properties设置logging.*属性）
2、重写了默认配置，设置日志文件大小在100MB时，按日期切分日志，切分后目录：
blog.2017-08-01.0 80MB
blog.2017-08-01.1 10MB
blog.2017-08-02.0 56MB
blog.2017-08-03.0 53MB
......
-->
3.运行
由于本系列博客只讲述博客后端的开发，前端不会细说，页面直接拿来用，可以直接从GitHub中下载前端页面（欢迎star）：https://github.com/oneStarLR/myblog-page ，将前端页面导入进项目中，注意目录别放错了
至此，基本框架搭建完成，可以运行一下了，可以看到在dev和pro配置下打印的log日志以及在项目中自动生成一个log文件夹，存放dev和pro日志文件。
dev日志打印：
pro日志打印：
开发的时候为了能看到更多的信息，使用dev配置环境
二、异常处理
在页面访问的时候，会有一些比较常见的异常报错信息，比如路径无法访问404异常、服务器错误500异常以及自己定义的错误页面等等，SpringBoot框架提供了处理错误页面的方法，在这里，咱们对404、500、error异常页面进行处理。
1.定义错误页面
可以在前端页面templates目录下有error文件夹，SpringBoot可以通过文件夹的名称和错误文件命名的方式找到异常页面，所以文件名称只能固定，有以下异常页面：
- 404.html
- 500.html
- error.html
可以通过控制器来测试一下，在com.cbx文件夹下面新建controller包，创建IndexController控制器作为首页控制器，代码如下：
package com.cbx.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
/**
* @author cbx
* @date 2022/3/3
* @apiNote 首页控制器
*/
@Controller
public class IndexController {
@GetMapping("/")
public String index(){
return "index";
}
}
404页面测试：可以在在浏览器输入：http://localhost:8080/ ，可以访问到博客的首页，可以通过改变路径，如加一个无效的后缀，访问后发现跳转到我自己写的404页面
500页面测试：可以在IndexController控制器中加一句错误代码，人为的让服务器出错，如加一句：int a = 9/0; （分母不能为零，这样服务器就会出错），然后访问：http://localhost:8080/， 发现跳转到了500页面，这就说明没有问题（记得把导致500的错误注释掉）
2.全局异常处理
对于404和500错误页面，SpringBoot可以根据页面的命名方式找到对应的文件，而自定义的错误就需要我们自己来拦截了，让代码出现问题的时候跳转到我们自己定义的错误页面，这里就需要自定义拦截器。
在com.cbx文件夹下面新建hander包，创建ControllerExceptionHandler错误页面拦截器，通过定义这个类来拦截所有的异常，代码如下：
package com.cbx.hander;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.annotation.AnnotationUtils;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import java.lang.annotation.Annotation;
/**
* @author cbx
* @date 2022/3/4
* @apiNote
* @Description: 拦截异常处理
*/
@ControllerAdvice
public class ControllerExceptionHandler {
// 将异常记录到日志
private final Logger logger = LoggerFactory.getLogger(this.getClass());
/**
* @Description: 处理错误信息
* @author cbx
* @date 2022/3/4
* @Param: request：访问的异常URL
* @Param: e：异常参数
* @Return: 返回错误信息页面
*/
@ExceptionHandler(Exception.class)
public ModelAndView exceptionHandler(HttpServletRequest request,Exception e) throws Exception{
// 记录异常信息:请求的url,异常系信息
logger.error("Request Url : {},Exception: {}",request.getRequestURI(),e);
// 当标识了状态码的时候就不拦截
if (AnnotationUtils.findAnnotation(e.getClass(), ResponseStatus.class)!=null){
throw e;
}
// 将记录的异常信息返回到error页面
ModelAndView mv = new ModelAndView();
mv.addObject("url",request.getRequestURL());
mv.addObject("exception", e);
mv.setViewName("error/error");
return mv;
}
}
分析：
- @ControllerAdvice表示拦截掉所有带有@Controller注解的控制器
- @ExceptionHandler表明是异常处理方法
- ModelAndView：返回一个页面信息
- 通过拦截异常信息，在日志中记录，并返回给error页面
- 标识了状态码的时候就不拦截，如资源找不到异常
3.资源找不到异常处理
对于资源找不到异常，一般也是要跳转到404页面的，这里就需要自定义一个异常类，专门用来应对资源找不到，在com.cbx文件夹下面新建NotFoundException类。
package com.cbx;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ResponseStatus;
/**
* @author cbx
* @date 2022/3/4
* @apiNote
* @Description: 自定义异常--资源找不到异常
*/
@ResponseStatus(HttpStatus.NOT_FOUND)
public class NotFoundException extends RuntimeException{
public NotFoundException(){
}
public NotFoundException(String message){
super(message);
}
public NotFoundException(String message, Throwable cause){
super(message,cause);
}
}
分析：
- 继承RuntimeException，实现继承RuntimeException的构造函数
- @ResponseStatus(HttpStatus.NOT_FOUND)注解表示资源找不到的状态码，标识了状态码的时候就不拦截
三、日志处理
采用SpringBoot中的AOP进行日志处理，AOP可以以切面的形式拦截，将日志内容记录下来，这里记录以下日志信息：
- 访问的URL
- 访问者的IP
- 访问时调用的方法
- 访问时传递的参数
- 访问时返回的内容
1.添加依赖
在pom.xml中添加AOP的依赖
<!--AOP-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
2.切面处理
在com.cbx文件夹下面新建aspect包，创建LogAspect日志切面处理类，在这里对日志进行处理，代码如下：
package com.cbx.aspect;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import javax.servlet.http.HttpServletRequest;
import java.util.Arrays;
/**
* @author cbx
* @date 2022/3/4
* @apiNote
*/
@Aspect
@Component
public class LogAspect {
private final Logger logger = LoggerFactory.getLogger(this.getClass());
// 拦截控制器
@Pointcut("execution(* com.cbx.controller.*.*(..))")
public void log() {
}
@Before("log()")
public void doBefore(JoinPoint joinPoint) {
ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
HttpServletRequest request = attributes.getRequest();
String url = request.getRequestURL().toString();
String ip = request.getRemoteAddr();
String classMethod = joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName();
Object[] args = joinPoint.getArgs();
RequestLog requestLog = new RequestLog(url, ip, classMethod, args);
logger.info("Request : {}", requestLog);
}
@After("log()")
public void doAfter() {
// logger.info("--------doAfter--------");
}
@AfterReturning(returning = "result",pointcut = "log()")
public void doAfterRuturn(Object result) {
logger.info("Result : {}", result);
}
private class RequestLog {
private String url;
private String ip;
private String classMethod;
private Object[] args;
public RequestLog(String url, String ip, String classMethod, Object[] args) {
this.url = url;
this.ip = ip;
this.classMethod = classMethod;
this.args = args;
}
@Override
public String toString() {
return "{" +
"url='" + url + '\'' +
", ip='" + ip + '\'' +
", classMethod='" + classMethod + '\'' +
", args=" + Arrays.toString(args) +
'}';
}
}
}
分析：
- @Aspect注解：AOP切面作用
- @Component注解：开启组件扫描，通过注解找到要扫描的对象
- @Pointcut("execution(* com.star.controller..(..))")：定义切面，申明log()是一个切面，通过execution来表示需要拦截的类，这里表示拦截控制器下面的所有类所有方法
- RequestLog：将请求的参数封装成一个内部类
- 在访问页面（controller）之前，拦截请求的URL、IP、调用的方法、传递的参数、返回的内容，并记录到日志
运行项目，访问http://localhost:8080/，可以在控制台看到打印日志信息，记录了请求的URL、IP、调用的方法、传递的参数、返回的内容，并输入到了日志
至此，配合前端页面，框架就搭建完成
评论