Spring Boot 3 开发上线一个前后端分离的生产级系统（四） - 日志 & 跨域配置

日志配置

Spring Boot 默认使用的是 Logback 日志实现，会自动读取类路径下的 logback-spring.xml, logback-spring.groovy, logback.xml, 或 logback.groovy 配置文件。

我们在项目 src/resource 下面添加如下内容的日志配置文件 logback-spring.xml 即可：

	<?xml version="1.0" encoding="UTF-8"?>
	<configuration>
	<!-- 彩色日志依赖的渲染类 -->
	<conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter"/>
	<conversionRule conversionWord="wex"
	converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter"/>
	<conversionRule conversionWord="wEx"
	converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter"/>
	<!-- 彩色日志格式 -->
	<property name="CONSOLE_LOG_PATTERN"
	value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
	<!-- %m输出的信息,%p日志级别,%t线程名,%d日期,%c类的全名,%i索引【从数字0开始递增】,,, -->
	<!-- appender是configuration的子节点，是负责写日志的组件。 -->
	<!-- ConsoleAppender：把日志输出到控制台 -->
	<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
	<encoder>
	<!--
	<pattern>%d %p (%file:%line\)- %m%n</pattern>
	-->
	<pattern>${CONSOLE_LOG_PATTERN}</pattern>
	<!-- 控制台也要使用UTF-8，不要使用GBK，否则会中文乱码 -->
	<charset>UTF-8</charset>
	</encoder>
	</appender>
	<!-- RollingFileAppender：滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 -->
	<!-- 以下的大概意思是：1.先按日期存日志，日期变了，将前一天的日志文件名重命名为XXX%日期%索引，新的日志仍然是demo.log -->
	<!-- 2.如果日期没有发生变化，但是当前日志的文件大小超过1KB时，对当前日志进行分割 重命名 -->
	<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
	<File>logs/novel.log</File>
	<!-- rollingPolicy:当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名。 -->
	<!-- TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动 -->
	<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
	<!-- 活动文件的名字会根据fileNamePattern的值，每隔一段时间改变一次 -->
	<!-- 文件名：logs/demo.2017-12-05.0.log -->
	<fileNamePattern>logs/debug.%d.%i.log</fileNamePattern>
	<!-- 每产生一个日志文件，该日志文件的保存期限为30天 -->
	<maxHistory>30</maxHistory>
	<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
	<!-- maxFileSize:这是活动文件的大小，默认值是10MB，测试时可改成1KB看效果 -->
	<maxFileSize>10MB</maxFileSize>
	</timeBasedFileNamingAndTriggeringPolicy>
	</rollingPolicy>
	<encoder>
	<!-- pattern节点，用来设置日志的输入格式 -->
	<pattern>
	%d %p (%file:%line\)- %m%n
	</pattern>
	<!-- 记录日志的编码:此处设置字符集 - -->
	<charset>UTF-8</charset>
	</encoder>
	</appender>
	<springProfile name="dev">
	<!-- ROOT 日志级别 -->
	<root level="INFO">
	<appender-ref ref="STDOUT"/>
	</root>
	<!-- 指定项目中某个包，当有日志操作行为时的日志记录级别 -->
	<!-- com.maijinjie.springboot 为根包，也就是只要是发生在这个根包下面的所有日志操作行为的权限都是DEBUG -->
	<!-- 级别依次为【从高到低】：FATAL > ERROR > WARN > INFO > DEBUG > TRACE -->
	<logger name="io.github.xxyopen" level="DEBUG" additivity="false">
	<appender-ref ref="STDOUT"/>
	</logger>
	</springProfile>
	<springProfile name="prod">
	<!-- ROOT 日志级别 -->
	<root level="INFO">
	<appender-ref ref="STDOUT"/>
	<appender-ref ref="FILE"/>
	</root>
	<!-- 指定项目中某个包，当有日志操作行为时的日志记录级别 -->
	<!-- com.maijinjie.springboot 为根包，也就是只要是发生在这个根包下面的所有日志操作行为的权限都是DEBUG -->
	<!-- 级别依次为【从高到低】：FATAL > ERROR > WARN > INFO > DEBUG > TRACE -->
	<logger name="io.github.xxyopen" level="ERROR" additivity="false">
	<appender-ref ref="STDOUT"/>
	<appender-ref ref="FILE"/>
	</logger>
	</springProfile>
	</configuration>

跨域配置

跨域是指浏览器从一个域名的网页去请求另一个域名的资源时，域名、端口、协议任一不同，都是跨域。在前后端分离的模式下，前后端的域名是不一致的，此时就会发生跨域访问问题。

跨域是出于浏览器的同源策略限制，同源策略（Sameoriginpolicy）是一种约定，它是浏览器最核心也最基本的安全功能，如果缺少了同源策略，则浏览器的正常功能可能都会受到影响。

我们可以通过前端配置、后端配置或 nginx 配置来解决跨域问题。

如果选择前端配置，我们可以使用 node 中间件 proxy 配置跨域，前端通过 node proxy 来转发我们的接口请求，和浏览器直接打交道的是 node proxy，这样可以避免浏览器的同源策略。配置示例如下：

	proxy: {
	'/api': {
	target: 'http://localhost:8888',
	// 请求改变源，此时 nginx 可以获取到真实的请求 ip
	changeOrigin: true
	}
	}

如果通过 nginx 配置来解决跨域问题，我们在配置 location 路径转发时需要加上如下的配置：

	# 允许的请求头
	add_header 'Access-Control-Allow-Methods' 'GET,OPTIONS,POST,PUT,DELETE' always;
	add_header 'Access-Control-Allow-Credentials' 'true' always;
	add_header 'Access-Control-Allow-Origin' '$http_origin' always;
	add_header Access-Control-Allow-Headers $http_access_control_request_headers;
	add_header Access-Control-Max-Age 3600;
	# 头转发
	proxy_set_header Host $host;
	proxy_set_header X-Real-Ip $remote_addr;
	proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
	proxy_connect_timeout 1000;
	proxy_read_timeout 1000;
	# 跨域配置
	if ($request_method = OPTIONS ) { return 200; }

因为我们项目的侧重点在后端，而且 Spring MVC 提供了跨域解决方案（CORS）的支持。所以我们这里通过后端配置来解决跨域问题。

首先我们需要在 application.yml 配置文件中添加跨域相关的配置：

	# 项目配置
	novel:
	# 跨域配置
	cors:
	# 允许跨域的域名
	allow-origins:
	- http://localhost:1024
	- http://localhost:8080

然后在io.github.xxyopen.novel.core.config包下创建 CorsProperties 类来绑定 CORS 配置属性:

	/**
	* 跨域配置属性
	*
	* @author xiongxiaoyang
	* @date 2022/5/17
	*/
	@ConfigurationProperties(prefix = "novel.cors")
	@Data
	public class CorsProperties {
	/**
	* 允许跨域的域名
	* */
	private List<String> allowOrigins;
	}

最后在io.github.xxyopen.novel.core.config包下增加如下的 CORS 配置类：

	/**
	* 跨域配置
	*
	* @author xiongxiaoyang
	* @date 2022/5/13
	*/
	@Configuration
	@EnableConfigurationProperties(CorsProperties.class)
	@RequiredArgsConstructor
	public class CorsConfig {
	private final CorsProperties corsProperties;
	@Bean
	public CorsFilter corsFilter() {
	CorsConfiguration config = new CorsConfiguration();
	// 允许的域,不要写*，否则cookie就无法使用了
	for (String allowOrigin : corsProperties.getAllowOrigins()) {
	config.addAllowedOrigin(allowOrigin);
	}
	// 允许的头信息
	config.addAllowedHeader("*");
	// 允许的请求方式
	config.addAllowedMethod("*");
	// 是否允许携带Cookie信息
	config.setAllowCredentials(true);
	UrlBasedCorsConfigurationSource configurationSource = new UrlBasedCorsConfigurationSource();
	// 添加映射路径，拦截一切请求
	configurationSource.registerCorsConfiguration("/**",config);
	return new CorsFilter(configurationSource);
	}
	}