Spring Cloud 升级之路 - 2020.0.x - 3. Undertow 的 acces
上一节咱们讲述了如何使用 Undertow 做为咱们的 Web 服务容器，本小节咱们来分析使用 Undertow 的另外一个问题，也就是如何配置 accesslog，以及 accesslog 的各类占位符。java
# accesslog 相关配置git
```github
server:spring
undertow:安全
# access log相关配置cookie
accesslog:app
# 存放目录，默认为 logs负载均衡
dir: ./logide
# 是否开启微服务
enabled: true
# 格式，各类占位符后面会详细说明
pattern: '{
"transportProtocol":"%{TRANSPORT_PROTOCOL}",
"scheme":"%{SCHEME}",
"protocol":"%{PROTOCOL}",
"method":"%{METHOD}",
"reqHeaderUserAgent":"%{i,User-Agent}",
"cookieUserId": "%{c,userId}",
"queryTest": "%{q,test}",
"queryString": "%q",
"relativePath": "%R, %{REQUEST_PATH}, %{RESOLVED_PATH}",
"requestLine": "%r",
"uri": "%U",
"thread": "%I",
"hostPort": "%{HOST_AND_PORT}",
"localIp": "%A",
"localPort": "%p",
"localServerName": "%v",
"remoteIp": "%a",
"remoteHost": "%h",
"bytesSent": "%b",
"time":"%{time,yyyy-MM-dd HH:mm:ss.S}",
"status":"%s",
"reason":"%{RESPONSE_REASON_PHRASE}",
"respHeaderUserSession":"%{o,userSession}",
"respCookieUserId":"%{resp-cookie,userId}",
"timeUsed":"%Dms, %Ts, %{RESPONSE_TIME}ms, %{RESPONSE_TIME_MICROS} us, %{RESPONSE_TIME_NANOS} ns",
}'
# 文件前缀，默认为 access_log
prefix: access.
# 文件后缀，默认为 log
suffix: log
# 是否另起日志文件写 access log，默认为 true
# 目前只能按照日期进行 rotate，一天一个日志文件
rotate: true
```
## 注意点 1：日志文件 rotate 目前只能按照日期
Undertow 的 accesslog 处理核心类抽象是 `io.undertow.server.handlers.accesslog.AccesslogReceiver`。因为目前 Undertow 的 `AccesslogReceiver` 只有一种实如今使用，也就是 `io.undertow.server.handlers.accesslog.DefaultAccessLogReceiver`。
查看 `DefaultAccessLogReceiver` 的 rotate 时机：
[`DefaultAccessLogReceiver`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/server/handlers/accesslog/DefaultAccessLogReceiver.java)
```
/**
* 计算 rotate 时间点
*/
private void calculateChangeOverPoint() {
Calendar calendar = Calendar.getInstance();
calendar.set(Calendar.SECOND, 0);
calendar.set(Calendar.MINUTE, 0);
calendar.set(Calendar.HOUR_OF_DAY, 0);
//当前时间日期 + 1，即下一天
calendar.add(Calendar.DATE, 1);
SimpleDateFormat df = new SimpleDateFormat("yyyy-MM-dd", Locale.US);
currentDateString = df.format(new Date());
// if there is an existing default log file, use the date last modified instead of the current date
if (Files.exists(defaultLogFile)) {
try {
currentDateString = df.format(new Date(Files.getLastModifiedTime(defaultLogFile).toMillis()));
} catch(IOException e){
// ignore. use the current date if exception happens.
}
}
//rotate 时机是下一天的 0 点
changeOverPoint = calendar.getTimeInMillis();
}
```
# accesslog 占位符
其实 Undertow 中的 accesslog 占位符，就是以前咱们提到的 Undertow Listener 解析请求后抽象的 HTTP server exchange 的属性。
[官网文档](https://undertow.io/undertow-docs/undertow-docs-2.1.0/#exchange-attributes)的表格并非最全的，而且注意点并无说明，例如某些占位符必须打开某些 Undertow 特性才能使用等等。这里咱们列出下。
首先先提出一个注意点，参数占位符，例如 `%{i,你要看的header值}` 查看 header 的某个 key 的值。**逗号后面注意不要有空格，由于这个空格会算入 key 里面致使拿不到你想要的 key**。
## 请求相关属性
| 描述 | 缩写占位符 | 全名占位符 | 参数占位符 | 源码 |
|------|-------|------|------|------|
| 请求传输协议，等价于**请求协议** | 无 | `%{TRANSPORT_PROTOCOL}` | 无 | [`TransportProtocolAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/TransportProtocolAttribute.java) |
| 请求模式，例如 http、https 等 | | `%{SCHEME}` | 无 | [`RequestSchemeAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/RequestSchemeAttribute.java) |
| 请求协议，例如 `HTTP/1.1` 等 | `%H` | `%{PROTOCOL}` | 无 | [`RequestProtocolAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/RequestProtocolAttribute.java) |
| 请求方法，例如 GET、POST 等 | `%m` | `%{METHOD}` | 无 | [`RequestMethodAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/RequestMethodAttribute.java) |
| 请求 Header 的某一个值 | 无 | 无 | `%{i,你要看的header值}` | [`RequestHeaderAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/RequestHeaderAttribute.java)|
| Cookie 的某一个值| 无 | 无 | `%{c,你要看的cookie值}` 或者 `%{req-cookie,你要看的cookie值}` | 分别对应 [`CookieAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/CookieAttribute.java) 和 [`RequestCookieAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/RequestCookieAttribute.java) |
| 路径参数 PathVariable 因为并无被 Undertow 的 Listener 或者 Handler 解析处理，因此拦截不到，没法确认是不是一个 PathVariable 仍是就是 url 路径。因此，**PathVariable 的占位符是不会起做用的**。 | 无 | 无 | `%{p, 你想查看的路径参数 key }` | [`PathParameterAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/PathParameterAttribute.java) |
| 请求参数，即 url 的 ? 以后键值对，这里能够选择查看某个 key 的值。| 无 | 无 | `%{q, 你想查看的请求参数 key}` | [`QueryParameterAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/QueryParameterAttribute.java) |
| 请求参数字符串，即 url 的 ? 以后的全部字符} |`%q`(不包含 ?)|`%{QUERY_STRING}`(不包含 ?);`%{BARE_QUERY_STRING}`(包含 ?)| 无 | [`QueryStringAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/QueryStringAttribute.java) |
|请求相对路径（在 Spring Boot 环境下，大多数状况 RequestPath 和 RelativePath 还有 ResolvedPath 是等价的），即除去 host，port，请求参数字符串的路径 | `%R` | `%{RELATIVE_PATH}` 或者 `%{REQUEST_PATH}` 或者 `%{RESOLVED_PATH}` | 无 | 分别对应 [`RelativePathAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/RelativePathAttribute.java) 和 [`RequestPathAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/RequestPathAttribute.java) 和 [`ResolvedPathAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/ResolvedPathAttribute.java)|
| 请求总体字符串，包括请求方法，请求相对路径，请求参数字符串，请求协议，例如 `Get /test?a=b HTTP/1.1` | `%r` | `%{REQUEST_LINE}` | 无 | [`RequestLineAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/RequestLineAttribute.java) |
| 请求 URI，包括请求相对路径，请求参数字符串 | `%U` | `%{REQUEST_URL}` | 无 | [`RequestURLAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/RequestURLAttribute.java) |
| 处理请求的线程 | `%I` | `%{THREAD_NAME}` | 无 | [`ThreadNameAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/ThreadNameAttribute.java) |
注意：
1. 路径参数 PathVariable 因为并无被 Undertow 的 Listener 或者 Handler 解析处理，因此拦截不到，没法确认是不是一个 PathVariable 仍是就是 url 路径。因此，**PathVariable 的占位符是不会起做用的**。
## 请求地址相关
| 描述 | 缩写占位符 | 全名占位符 | 参数占位符 | 源码 |
|------|-------|------|------|------|
|host 和 port，通常就是 HTTP 请求 Header 中的 Host 值，若是 Host 为空则获取本地地址和端口，若是没获取到端口则根据协议用默认端口（http:80,，https:443）| 无 | `%{HOST_AND_PORT}` | 无 | [`HostAndPortAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/HostAndPortAttribute.java) |
|请求本地地址 IP| `%A` | `%{LOCAL_IP}` | 无 | [`LocalIPAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/LocalIPAttribute.java)|
|请求本地端口 Port| `%p` | `%{LOCAL_PORT}` | 无 | [`LocalPortAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/LocalPortAttribute.java)|
|请求本地主机名，通常就是 HTTP 请求 Header 中的 Host 值，若是 Host 为空则获取本地地址 | `%v` | `%{LOCAL_SERVER_NAME}` | 无 | [`LocalServerNameAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/LocalServerNameAttribute.java)|
|请求远程主机名，经过链接获取远端的主机地址 | `%h` | `%{REMOTE_HOST}` | 无 | [`RemoteHostAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/RemoteHostAttribute.java)|
|请求远程 IP，经过链接获取远端的 IP | `%a` | `%{REMOTE_IP}` | 无 | [`RemoteIPAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/RemoteIPAttribute.java)|
注意：
1. 请求的远程地址咱们通常不从请求链接获取，而是经过 Http Header 里面的 `X-forwarded-for` 或者 `X-real-ip` 等获取，由于如今请求都是经过各类 ***，负载均衡器发上来的。
## 响应相关属性
| 描述 | 缩写占位符 | 全名占位符 | 参数占位符 | 源码 |
|------|-------|------|------|------|
| 发送的字节数大小，除了 Http Header 之外 | `%b` (若是为空就是 -) 或者 `%B` (若是为空就是 0) | `%{BYTES_SENT}` (若是为空就是 0) | 无 | [`BytesSentAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/BytesSentAttribute.java)|
| accesslog 时间，这个不是收到请求的时间，而是响应的时间 | `%t` | `%{DATE_TIME}` | `%{time, 你自定义的 java 中 SimpleDateFormat 的格式}` | [`DateTimeAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/DateTimeAttribute.java)|
| HTTP 响应状态码 | `%s` | `%{RESPONSE_CODE}` | 无 | [`ResponseCodeAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/ResponseCodeAttribute.java)|
| HTTP 响应缘由 | 无 | `%{RESPONSE_REASON_PHRASE}` | 无 | [`ResponseReasonPhraseAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/ResponseReasonPhraseAttribute.java)|
| 响应 Header 的某一个值 | 无 | 无 | `%{o,你要看的header值}` | [`ResponseHeaderAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/ResponseHeaderAttribute.java)|
| 响应 Cookie 的某一个值 | 无 | 无 | `%{resp-cookie,你要看的cookie值}` | [`ResponseCookieAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/ResponseCookieAttribute.java)|
| 响应时间，**默认 undertow 没有开启请求时间内统计，须要打开才能统计响应时间** | `%D`(毫秒，例如 56 表明 56ms) `%T`(秒，例如 5.067 表明 5.067 秒) | `%{RESPONSE_TIME}`(等价于 `%D`) `%{RESPONSE_TIME_MICROS}` （微秒） `%{RESPONSE_TIME_NANOS}`（纳秒） | 无 | [`ResponseTimeAttribute`](https://github.com/undertow-io/undertow/blob/2.2.7.Final/core/src/main/java/io/undertow/attribute/ResponseTimeAttribute.java)|
注意：**默认 undertow 没有开启请求时间内统计，须要打开才能统计响应时间**，如何开启呢？经过注册一个 `WebServerFactoryCustomizer` 到 Spring ApplicationContext 中便可。请看下面的代码（项目地址：[https://github.com/HashZhang/spring-cloud-scaffold/blob/master/spring-cloud-iiford/](https://github.com/HashZhang/spring-cloud-scaffold/blob/master/spring-cloud-iiford/)）：
[`spring.factories`（省略无关代码）](https://github.com/HashZhang/spring-cloud-scaffold/blob/master/spring-cloud-iiford/spring-cloud-iiford-service-common/src/main/resources/META-INF/spring.factories)
```
# AutoConfiguration
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.github.hashjang.spring.cloud.iiford.service.common.auto.UndertowAutoConfiguration
```
[`UndertowAutoConfiguration`](https://github.com/HashZhang/spring-cloud-scaffold/blob/master/spring-cloud-iiford/spring-cloud-iiford-service-common/src/main/java/com/github/hashjang/spring/cloud/iiford/service/common/auto/UndertowAutoConfiguration.java)
```
//设置proxyBeanMethods=false，由于没有 @Bean 的方法互相调用须要每次返回同一个 Bean，不必代理，关闭增长启动速度
@Configuration(proxyBeanMethods = false)
@Import(WebServerConfiguration.class)
public class UndertowAutoConfiguration {
}
```
[`WebServerConfiguration`](https://github.com/HashZhang/spring-cloud-scaffold/blob/master/spring-cloud-iiford/spring-cloud-iiford-service-common/src/main/java/com/github/hashjang/spring/cloud/iiford/service/common/undertow/WebServerConfiguration.java)
```
//设置proxyBeanMethods=false，由于没有 @Bean 的方法互相调用须要每次返回同一个 Bean，不必代理，关闭增长启动速度
@Configuration(proxyBeanMethods = false)
public class WebServerConfiguration {
@Bean
public WebServerFactoryCustomizer<ConfigurableUndertowWebServerFactory> undertowWebServerAccessLogTimingEnabler(ServerProperties serverProperties) {
return new DefaultWebServerFactoryCustomizer(serverProperties);
}
}
```
[`DefaultWebServerFactoryCustomizer`](https://github.com/HashZhang/spring-cloud-scaffold/blob/master/spring-cloud-iiford/spring-cloud-iiford-service-common/src/main/java/com/github/hashjang/spring/cloud/iiford/service/common/undertow/DefaultWebServerFactoryCustomizer.java)
```
public class DefaultWebServerFactoryCustomizer implements WebServerFactoryCustomizer<ConfigurableUndertowWebServerFactory> {
private final ServerProperties serverProperties;
public DefaultWebServerFactoryCustomizer(ServerProperties serverProperties) {
this.serverProperties = serverProperties;
}
@Override
public void customize(ConfigurableUndertowWebServerFactory factory) {
String pattern = serverProperties.getUndertow().getAccesslog().getPattern();
// 若是 accesslog 配置中打印了响应时间，则打开记录请求开始时间配置
if (logRequestProcessingTiming(pattern)) {
factory.addBuilderCustomizers(builder -> builder.setServerOption(UndertowOptions.RECORD_REQUEST_START_TIME, true));
}
}
private boolean logRequestProcessingTiming(String pattern) {
if (StringUtils.isBlank(pattern)) {
return false;
}
//判断 accesslog 是否配置了查看响应时间
return pattern.contains(ResponseTimeAttribute.RESPONSE_TIME_MICROS)
|| pattern.contains(ResponseTimeAttribute.RESPONSE_TIME_MILLIS)
|| pattern.contains(ResponseTimeAttribute.RESPONSE_TIME_NANOS)
|| pattern.contains(ResponseTimeAttribute.RESPONSE_TIME_MILLIS_SHORT)
|| pattern.contains(ResponseTimeAttribute.RESPONSE_TIME_SECONDS_SHORT);
}
}
```
## 其余
还有安全相关的属性（SSL 相关，登陆认证 Authentication 相关），微服务内部调用通常用不到，咱们这里就不赘述了。
其它内置的属性，在 Spring Boot 环境下通常用不到，咱们这里就不讨论了。
## 举例
咱们最开始配置的 accesslog 的例子请求返回以下（ JSON 格式化以后的结果）：
```
{
"transportProtocol": "http/1.1",
"scheme": "http",
"protocol": "HTTP/1.1",
"method": "GET",
"reqHeaderUserAgent": "PostmanRuntime/7.26.10",
"cookieUserId": "testRequestCookieUserId",
"queryTest": "1",
"queryString": "?test=1&query=2",
"relativePath": "/test, /test, -",
"requestLine": "GET /test?test=1&query=2 HTTP/1.1",
"uri": "/test",
"thread": "XNIO-2 task-1",
"hostPort": "127.0.0.1:8102",
"localIp": "127.0.0.1",
"localPort": "8102",
"localServerName": "127.0.0.1",
"remoteIp": "127.0.0.1",
"remoteHost": "127.0.0.1",
"bytesSent": "26",
"time": "2021-04-08 00:07:50.410",
"status": "200",
"reason": "OK",
"respHeaderUserSession": "testResponseHeaderUserSession",
"respCookieUserId": "testResponseCookieUserId",
"timeUsed": "3683ms, 3.683s, 3683ms, 3683149 us, 3683149200 ns",
}
```
- 1. Spring Cloud 升级之路 - 2020.0.x - 2. 使用 Undertow 做为咱们
- 2. Spring Cloud 升级之路-2020.0.x -7.使用 Spring Cloud LoadBalancer (2)
- 3. Spring Cloud 升级之路 - 2020.0.x - 5. 理解 NamedContextFactory
- 4. Spring Cloud 升级之路 - 2020.0.x - 2. 使用 Undertow 做为咱们的 Web 服务容器
- 5. Spring Cloud 升级之路 - 2020.0.x - 4. 使用 Eureka 做为注册中心
- 6. Spring Cloud 升级之路 - 2020.0.x - 1. 背景知识、需求描述与公共依赖
- 7. Spring Cloud升级之路 - Hoxton - 3. 负载均衡从ribbon替换成spring-cloud-loadbalancer
- 8. spring 3.x 升级 spring 4 实践
- 9. spring boot升级到spring cloud
- 10. Spring Cloud升级之路 - Hoxton - 1.背景介绍与要实现的功能
- 更多相关文章...
- • RSS
元素 - RSS 教程 - • Hibernate的一级缓存 - Hibernate教程
- • Spring Cloud 微服务实战(三) - 服务注册与发现
- • 互联网组织的未来：剖析GitHub员工的任性之源
-
每一个你不满意的现在，都有一个你没有努力的曾经。
- 1. Spring Cloud 升级之路 - 2020.0.x - 2. 使用 Undertow 做为咱们
- 2. Spring Cloud 升级之路-2020.0.x -7.使用 Spring Cloud LoadBalancer (2)
- 3. Spring Cloud 升级之路 - 2020.0.x - 5. 理解 NamedContextFactory
- 4. Spring Cloud 升级之路 - 2020.0.x - 2. 使用 Undertow 做为咱们的 Web 服务容器
- 5. Spring Cloud 升级之路 - 2020.0.x - 4. 使用 Eureka 做为注册中心
- 6. Spring Cloud 升级之路 - 2020.0.x - 1. 背景知识、需求描述与公共依赖
- 7. Spring Cloud升级之路 - Hoxton - 3. 负载均衡从ribbon替换成spring-cloud-loadbalancer
- 8. spring 3.x 升级 spring 4 实践
- 9. spring boot升级到spring cloud
- 10. Spring Cloud升级之路 - Hoxton - 1.背景介绍与要实现的功能