我有很多方法的RESTEasy Web服务器。我想要实现logback来跟踪所有请求和响应,但是我不想添加log.info()
到每个方法中。
也许有一种方法可以将请求和响应收集到一个地方并记录下来。也许像RESTEasy上的HTTP请求过程链上的过滤器一样。
@Path("/rest")
@Produces("application/json")
public class CounterRestService {
//Don't want use log in controler every method to track requests and responces
static final Logger log = LoggerFactory.getLogger(CounterRestService.class);
@POST
@Path("/create")
public CounterResponce create(@QueryParam("name") String name) {
log.info("create "+name)
try {
CounterService.getInstance().put(name);
log.info("responce data"); // <- :((
return new CounterResponce();
} catch (Exception e){
log.info("responce error data"); // <- :((
return new CounterResponce("error", e.getMessage());
}
}
@POST
@Path("/insert")
public CounterResponce create(Counter counter) {
try {
CounterService.getInstance().put(counter);
return new CounterResponce();
} catch (Exception e){
return new CounterResponce("error", e.getMessage());
}
}
...
}
您可以创建过滤器并将其轻松绑定到需要记录的端点,从而使端点保持精简并专注于业务逻辑。
要将过滤器绑定到REST端点,JAX-RS提供了元注释@NameBinding
,它可以按以下方式使用:
@NameBinding
@Retention(RUNTIME)
@Target({TYPE, METHOD})
public @interface Logged { }
该@Logged
注释将被用来装饰一个过滤器类,它实现ContainerRequestFilter
,让您在处理请求:
@Logged
@Provider
public class RequestLoggingFilter implements ContainerRequestFilter {
@Override
public void filter(ContainerRequestContext requestContext) throws IOException {
// Use the ContainerRequestContext to extract information from the HTTP request
// Information such as the URI, headers and HTTP entity are available
}
}
该@Provider
注释标记的扩展接口,应该由JAX-RS是可发现的实现过程中提供扫描相运行时。
在ContainerRequestContext
帮助你提取HTTP请求信息。
以下是ContainerRequestContext
API中从HTTP请求获取信息的方法,这些信息可能对您的日志有用:
ContainerRequestContext#getMethod()
:从请求中获取HTTP方法。ContainerRequestContext#getUriInfo()
:从HTTP请求获取URI信息。ContainerRequestContext#getHeaders()
:从HTTP请求中获取标头。ContainerRequestContext#getMediaType()
:获取实体的媒体类型。ContainerRequestContext#getEntityStream()
:获取实体输入流。要记录响应,请考虑实施ContainerResponseFilter
:
@Logged
@Provider
public class ResponseLoggingFilter implements ContainerResponseFilter {
@Override
public void filter(ContainerRequestContext requestContext,
ContainerResponseContext responseContext) throws IOException {
// Use the ContainerRequestContext to extract information from the HTTP request
// Use the ContainerResponseContext to extract information from the HTTP response
}
}
在ContainerResponseContext
帮助你提取HTTP响应信息。
以下是ContainerResponseContext
API的一些方法,这些方法可从HTTP响应中获取对您的日志有用的信息:
ContainerResponseContext#getStatus()
:从HTTP响应中获取状态代码。ContainerResponseContext#getHeaders()
:从HTTP响应中获取标头。ContainerResponseContext#getEntityStream()
:获取实体输出流。要将过滤器绑定到端点方法或类,请使用@Logged
上面定义的注释对它们进行注释。对于带有注释的方法和/或类,将执行过滤器:
@Path("/")
public class MyEndpoint {
@GET
@Path("{id}")
@Produces("application/json")
public Response myMethod(@PathParam("id") Long id) {
// This method is not annotated with @Logged
// The logging filters won't be executed when invoking this method
...
}
@DELETE
@Logged
@Path("{id}")
@Produces("application/json")
public Response myLoggedMethod(@PathParam("id") Long id) {
// This method is annotated with @Logged
// The request logging filter will be executed before invoking this method
// The response logging filter will be executed before invoking this method
...
}
}
在上面的示例中,日志记录过滤器将仅针对进行执行,myLoggedMethod(Long)
因为它带有注释@Logged
。
除了ContainerRequestContext
和ContainerResponseFilter
接口中可用的方法外,您还可以ResourceInfo
使用@Context
以下方法注入过滤器:
@Context
ResourceInfo resourceInfo;
它可以用来获取Method
和Class
匹配请求的URL其中:
Class<?> resourceClass = resourceInfo.getResourceClass();
Method resourceMethod = resourceInfo.getResourceMethod();
HttpServletRequest
并且HttpServletResponse
也可用于注射:
@Context
HttpServletRequest httpServletRequest;
@Context
HttpServletResponse httpServletResponse;
本文收集自互联网,转载请注明来源。
如有侵权,请联系[email protected] 删除。
我来说两句