win.hupubao.common.annotations.LogReqResArgs Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2018 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * You may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package win.hupubao.common.annotations;

import java.lang.annotation.*;

/**
 *
 * @author ysdxz207
 * @date 2018-06-08 17:48:33
 * 是否记录请求及返回参数日志功能注解
 * 有此注解则记录日志
 * 使用条件：有HttpServletRequest和HttpServletResponse参数，且有返回值
 */

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
@Inherited// 支持继承，这样在aop的cglib动态代理类中才能获取到注解
public @interface LogReqResArgs {
    /**
     * 请求参数日志头，默认值为RequestMapping的路径，若无注解则是方法名
     * @return
     */
    public String title() default "";
    public String titleRequest() default "request parameters:";
    public String titleResponse() default "response result:";
    public String titleException() default "exception:";
    public boolean logException() default true;

    /**
     * 记录返回结果时带上请求参数
     * @return
     */
    public boolean logResponseWithRequest() default false;
}