java API接口怎么日志

在 Java 里，“API 接口怎么打日志”通常有几层做法，从最基础到生产级方案都给你讲清楚。

一、最基础：使用日志框架（不要 System.out）

❌ 不推荐

System.out.println("请求来了");

✅ 推荐（SLF4J + Logback / Log4j2）

1. 引入依赖（Spring Boot 自带）

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

2. Controller 中打日志

@RestController
@Slf4j
public class UserController {

    @GetMapping("/user/{id}")
    public User getUser(@PathVariable Long id) {
        log.info("查询用户，id={}", id);
        return userService.getById(id);
    }
}

二、API 接口统一日志（推荐）：使用过滤器 / 拦截器

方式一：Spring 拦截器（简单清晰）

@Component
public class LogInterceptor implements HandlerInterceptor {

    private static final Logger log =
        LoggerFactory.getLogger(LogInterceptor.class);

    @Override
    public boolean preHandle(HttpServletRequest request,
                             HttpServletResponse response,
                             Object handler) {
        log.info("API请求: {} {}",
                request.getMethod(),
                request.getRequestURI());
        return true;
    }
}

注册拦截器：

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Autowired
    private LogInterceptor logInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(logInterceptor)
                .addPathPatterns("/**");
    }
}

三、更专业：统一记录请求 & 响应（AOP）

使用 AOP 记录 Controller 日志

@Aspect
@Component
@Slf4j
public class ApiLogAspect {

    @Around("execution(* com.xxx.controller..*(..))")
    public Object logApi(ProceedingJoinPoint pjp) throws Throwable {
        long start = System.currentTimeMillis();
        String method = pjp.getSignature().getName();

        log.info("接口开始: {}", method);
        Object result = pjp.proceed();
        log.info("接口结束: {}, 耗时={}ms",
                method, System.currentTimeMillis() - start);
        return result;
    }
}

四、最强方案：Spring Boot 自带请求日志（HttpLogging）

logging:
  level:
    org.springframework.web: DEBUG

或更细：

logging:
  level:
    org.springframework.web.servlet: DEBUG

五、生产级建议（重点）

✅ 日志内容建议包含：

• 请求 URL
• HTTP 方法
• 请求参数
• 响应状态
• 耗时
• 用户 ID（如有）

✅ 不要打印：

• 密码
• token
• 身份证号

✅ 使用：

log.info("userId={}, api={}", userId, api);

而不是字符串拼接

六、常见组合总结

如果你用的是 Spring Boot / Spring Cloud / 纯 Servlet / 特定框架，可以告诉我，我可以给你更贴合的示例。