自定义注解实现返回API统一格式数据

最新推荐文章于 2024-04-12 09:45:22 发布
最新推荐文章于 2024-04-12 09:45:22 发布
阅读量1.3k 收藏 4
点赞数 2
分类专栏： 实用技巧 文章标签： 注解实现统一格式 API统一数据格式 接口格式 接口数据规范 自定义注解处理接口格式问题
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/l_learning/article/details/103089556
版权

自定义注解实现返回API统一格式数据


通过添加在WEB层的自定义注解来判断是否对接口返回格式数据进行处理

1.新建注解

package com.api.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface ResponseResult {

}

2.新建拦截器，并配置拦截器

拦截器用来拦截请求，并根据该URI是否添加@ResponseResult来设置该RUI是否需要对返回数据进行封装

package com.api.interceptor;

import java.lang.reflect.Method;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.stereotype.Component;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import com.api.annotation.ResponseResult;
import com.api.cache.ResponseURICache;

@Component
public class ResponsResultInterceptor implements HandlerInterceptor {

	@Override
	public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
		//请求的方法
		if(handler instanceof HandlerMethod){
			HandlerMethod handlerMethod = (HandlerMethod) handler;
			Class<?> clazz = handlerMethod.getBeanType();
			Method method = handlerMethod.getMethod();
			String rui = request.getRequestURI();
			if(null == ResponseURICache.getInstance().get(rui)) {
				if(clazz.isAnnotationPresent(ResponseResult.class)){
					ResponseURICache.getInstance().set(rui, true);
				}else if(method.isAnnotationPresent(ResponseResult.class)){
					ResponseURICache.getInstance().set(rui, true);
				}else{
					ResponseURICache.getInstance().set(rui, false);
				}
			}
		}
		return true;
	}
	
	@Override
	public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception exception)
			throws Exception {
		// TODO Auto-generated method stub

	}

	@Override
	public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView view)
			throws Exception {
		// TODO Auto-generated method stub

	}

}

配置拦截器

package com.api.config;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.format.FormatterRegistry;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.validation.MessageCodesResolver;
import org.springframework.validation.Validator;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.method.support.HandlerMethodReturnValueHandler;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.config.annotation.AsyncSupportConfigurer;
import org.springframework.web.servlet.config.annotation.ContentNegotiationConfigurer;
import org.springframework.web.servlet.config.annotation.CorsRegistry;
import org.springframework.web.servlet.config.annotation.DefaultServletHandlerConfigurer;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.PathMatchConfigurer;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
import org.springframework.web.servlet.config.annotation.ViewResolverRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import com.api.interceptor.ResponsResultInterceptor;

@Configuration
public class WebConfigurer implements WebMvcConfigurer {
	
	@Autowired
	private ResponsResultInterceptor responsResultInterceptor;

	@Override
	public void addInterceptors(InterceptorRegistry interceptorRegistry) {
		// addPathPatterns("/**") 表示拦截所有的请求，
        // excludePathPatterns("/login", "/register") 表示除了登陆与注册之外，因为登陆注册不需要登陆也可以访问
		interceptorRegistry.addInterceptor(responsResultInterceptor).addPathPatterns("/**");
	}

	@Override
	public void addResourceHandlers(ResourceHandlerRegistry resourceHandlerRegistry) {
		// TODO Auto-generated method stub

	}

	@Override
	public void addArgumentResolvers(List<HandlerMethodArgumentResolver> arg0) {
		// TODO Auto-generated method stub
		
	}

	@Override
	public void addCorsMappings(CorsRegistry arg0) {
		// TODO Auto-generated method stub
		
	}

	@Override
	public void addFormatters(FormatterRegistry arg0) {
		// TODO Auto-generated method stub
		
	}

	@Override
	public void addReturnValueHandlers(List<HandlerMethodReturnValueHandler> arg0) {
		// TODO Auto-generated method stub
		
	}

	@Override
	public void addViewControllers(ViewControllerRegistry arg0) {
		// TODO Auto-generated method stub
		
	}

	@Override
	public void configureAsyncSupport(AsyncSupportConfigurer arg0) {
		// TODO Auto-generated method stub
		
	}

	@Override
	public void configureContentNegotiation(ContentNegotiationConfigurer arg0) {
		// TODO Auto-generated method stub
		
	}

	@Override
	public void configureDefaultServletHandling(DefaultServletHandlerConfigurer arg0) {
		// TODO Auto-generated method stub
		
	}

	@Override
	public void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> arg0) {
		// TODO Auto-generated method stub
		
	}

	@Override
	public void configureMessageConverters(List<HttpMessageConverter<?>> arg0) {
		// TODO Auto-generated method stub
		
	}

	@Override
	public void configurePathMatch(PathMatchConfigurer arg0) {
		// TODO Auto-generated method stub
		
	}

	@Override
	public void configureViewResolvers(ViewResolverRegistry arg0) {
		// TODO Auto-generated method stub
		
	}

	@Override
	public void extendHandlerExceptionResolvers(List<HandlerExceptionResolver> arg0) {
		// TODO Auto-generated method stub
		
	}

	@Override
	public void extendMessageConverters(List<HttpMessageConverter<?>> arg0) {
		// TODO Auto-generated method stub
		
	}

	@Override
	public MessageCodesResolver getMessageCodesResolver() {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	public Validator getValidator() {
		// TODO Auto-generated method stub
		return null;
	}

}

3.新建返回枚举类，返回格式封装类，错误返回格式类

3.1 格式定义

package com.api.result;

public enum ResultCode {
	//成功
	SUCCESS(1,"成功"),
	//参数错误100-199
	PARAM_IS_INVALID(101,"参数无效"),
	PARAM_IS_BLANK(102,"参数为空"),
	PARAM_TYPE_BIND_ERROR(103,"参数类型错误"),
	PARAM_NOT_COMPLETE(104,"参数缺失"),
	//用户错误200-299
	USER_NOT_LOGGED_IN(201,"用户未登录，访问的路径需要验证，请登录"),
	USER_LOGIN_ERROR(202,"账号不存在或密码错误"),
	USER_ACCOUNT_FORBIDDEN(203,"账号已被禁用"),
	USER_NOT_EXIST(204,"用户不存在"),
	USER_HAS_EXISTED(205,"用户已存在");
	
	private Integer code;
	
	private String message;
	
	ResultCode(Integer code, String message) {
		this.code = code;
		this.message = message;
	}
	
	public Integer code() {
		return this.code;
	}

	public String message() {
		return this.message;
	}
	
}

3.2 统一返回格式

package com.api.result;

import java.io.Serializable;

public class Result implements Serializable {
	
	private static final long serialVersionUID = 1L;

	private Integer code;
	
	private String message;

	private Object data;

	public Result() {
	}

	public Result(ResultCode resultCode, Object data) {
		this.code = resultCode.code();
		this.message = resultCode.message();
		this.data = data;
	}
	
	public static Result success(){
		Result result = new Result();
		result.setResultCode(ResultCode.SUCCESS);
		return result;
	}
	
	private void setResultCode(ResultCode resultCode) {
		this.code = resultCode.code();
		this.message = resultCode.message();
	}

	public static Result success(Object data){
		Result result = new Result();
		result.setResultCode(ResultCode.SUCCESS);
		result.setData(data);
		return result;
	}
	
	public static Result failure(ResultCode resultCode){
		Result result = new Result();
		result.setResultCode(resultCode);
		return result;
	}
	
	public static Result failure(ResultCode resultCode, Object data){
		Result result = new Result();
		result.setResultCode(resultCode);
		result.setData(data);
		return result;
	}
	
	public static Result failure(Integer code, String message, Object errors) {
		Result result = new Result();
		result.setCode(code);
		result.setMessage(message);
		result.setData(errors);
		return result;
	}

	public Integer getCode() {
		return code;
	}

	public void setCode(Integer code) {
		this.code = code;
	}

	public String getMessage() {
		return message;
	}

	public void setMessage(String message) {
		this.message = message;
	}

	public Object getData() {
		return data;
	}

	public void setData(Object data) {
		this.data = data;
	}

}

3.3 异常返回格式

package com.api.result;

public class ErrorResult {
	
	private Integer code;
	
	private String message;
	
	private Object errors;

	public Integer getCode() {
		return code;
	}

	public void setCode(Integer code) {
		this.code = code;
	}

	public String getMessage() {
		return message;
	}

	public void setMessage(String message) {
		this.message = message;
	}

	public Object getErrors() {
		return errors;
	}

	public void setErrors(Object errors) {
		this.errors = errors;
	}

}

3.4 新建ResponseResultHandle 类实现ResponseBodyAdvice接口,用于实现自定义返回类型，全局异常处理

package com.api.handler;

import javax.servlet.http.HttpServletRequest;

import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

import com.api.cache.ResponseURICache;
import com.api.result.ErrorResult;
import com.api.result.Result;

@ControllerAdvice
public class ResponseResultHandle implements ResponseBodyAdvice<Object> {

	//是否请求包含了包装注解标记，没有就直接返回，不需要重写返回体
	@Override
	public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
		ServletRequestAttributes sra = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
		HttpServletRequest request = sra.getRequest();
		//判断请求是否有包装标记
		return ResponseURICache.getInstance().get(request.getRequestURI());
	}
	
	@Override
	public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType,
			Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
		//进入返回体重写格式
		if(body instanceof ErrorResult){
			//返回值异常，作包装处理
			ErrorResult errorResult = (ErrorResult) body;
			return Result.failure(errorResult.getCode(), errorResult.getMessage(), errorResult.getErrors());
		}
		return Result.success(body);
	}
	
	@ExceptionHandler(Exception.class)
	@ResponseBody
	public ErrorResult handleRuntimeException(Exception e){
		ErrorResult errorResult = new ErrorResult();
		errorResult.setCode(500);
		errorResult.setMessage("服务器异常");
		errorResult.setErrors(errorResult.getErrors());
		return errorResult;
	}

}

4.新建缓存类

可以根据具体需求使用缓存数据库代替缓存类，这里使用一个用hashMap实现缓存类

package com.api.cache;

import java.util.HashMap;
import java.util.Map;

public class ResponseURICache {
	
	//缓存map
    private Map<String, Boolean> cacheMap = new HashMap<String, Boolean>();
    
    //禁止指令重排优化
  	private static volatile ResponseURICache URICACHE;
  	
  	private ResponseURICache(){}

  	public static ResponseURICache getInstance(){
  		if(null == URICACHE){
  			synchronized(ResponseURICache.class){
  				if(null == URICACHE){
  					URICACHE = new ResponseURICache();
  				}
  			}
  		}
  		return URICACHE;
  	}

    /**
     *  设置缓存值
     * @param key
     * @param value
     */
    public void set(String key, Boolean value) {
        cacheMap.put(key, value);
    }

    /**
     *  获取缓存key的value值
     * @param key
     * @return
     */
    public Boolean get(String key) {
        if (!cacheMap.containsKey(key)) {
            return null;
        }
        return cacheMap.get(key);
    }
}

5.Web控制层添加注解

package com.api.controll;

import java.util.HashMap;
import java.util.Map;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

import com.api.annotation.ResponseResult;

@RestController
@ResponseBody
public class BookControll {
	
	@GetMapping("book")
	@ResponseResult
	public Object getBook(){
		Map<String, String> map = new HashMap<String, String>();
		map.put("title", "倾城之恋");
		map.put("author", "张爱玲");
		return map;
	}

	@GetMapping("/book/name")
	public Object getBookById(){
		Map<String, String> map = new HashMap<String, String>();
		map.put("title", "金锁记");
		map.put("author", "张爱玲");
		return map;
	}
	
}
l_learning
关注
专栏目录
【Java实战】使用自定义注解实现参数校验详解
~~~~~~~BUG FLY~~~~~~~~~
04-19 2864
由于实际开发中遇到大量相同的条件参数验证，不想写重复代码及让代码看起来更加优雅简洁，所以决定使用自定义注解进行参数校验Java注解是附加在代码中的一些元信息，用于一些工具在编译、运行时进行解析和使用，起到说明、配置的功能，注解相关类都包含在java.lang.annotation包中其中参数校验的注解来自三方面，分别是javax.validation:validation-api，对应包javax.validation.constraints。
基于.NetCore和ABP.VNext的项目实战五：自定义消息返回，统一规范API
最新发布
yigu4011的博客
05-27 180
支持返回参数的api使用，T就是我们的返回结果，然后继承ServiceResult，指定T为class。层主要是公共的工具类、扩展方法，将统一返回模型放在这里，新建Base文件夹，新建Enum文件夹，定义一个。还需要返回带分页的数据，所以需要扩展一个分页的响应实体，当我们使用的时候，直接将分页响应实体作为上面写的。中的T参数，即可满足需求，新建文件夹PageList，添加总数接口。方法，当我们成功返回数据或者当系统出错或者参数异常的时候执行。，它同时也要接受一个泛型参数 T。，在构造函数中为其赋值。
spring boot 统一JSON格式的接口返回结果的实现
10-16
主要介绍了spring boot 统一JSON格式的接口返回结果的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
[Spring Boot]使用自定义注解统一请求返回值
snowiest的博客
01-02 987
使用自定义注解统一请求返回值 自定义一个注解，用于标记需要重写返回值的方法/类 package com.timee.annotation; import java.lang.annotation.*; @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.TYPE, ElementType.METHOD}) @Documented public @interface ResponseData { } 使用拦截器拦截所有请求 创建拦截器 pub
自定义注解实现接口操作记录日志
逆天killer的博客
01-13 258
接口拦截器–附带了登录拦截 package com.futuredata.cloud.cap.aop; import com.futuredata.cloud.cap.config.feign.UaaFeignService; import com.futuredata.cloud.cap.config.feign.vo.UserVo; import com.futuredata.cloud.cap.mapper.UserLogMapper; import com.futuredata.cloud.cap
格式化输出json数据
qingqingzijinxin的专栏
09-24 893
格式化输出json数据
自定义注解实现接口统一返回(携带注解才会统一返回)
qq_43759721的博客
04-12 347
实现自定义注解: 优点:只要在接口类或者接口方法上携带该注解,接口都可以自动通过类似Result返回,不需要自己手动规整统一返回。问题: 发现每个接口请求返回的内容都不一样,前端处理起来麻烦;后端处理的话每个接口都要通过类似Result的对象返回。其中的"com.tool.controller"为自己controller对应的包路径。主要的目的是判断是否使用了@UnifiedReturn注解标注;创建标识注解类 UnifiedReturn (注解名字自定义)定义code编码 ResultCode。
springboot工程自定义response注解、自定义规范化返回数据结构
09-02
总结，通过以上步骤，我们可以实现在Spring Boot工程中对返回数据结构的自定义，确保每个API返回的数据都遵循一致的格式。这提高了API的可读性和易用性，也方便了前后端交互。在实际项目中，可以根据需求进一步定制...
API统一返回数据格式
meiyouyaCSDN的博客
03-08 1961
如今的项目，基本上都是前后端分离，而且前端的生态也已经很强大。后端基本上只要保证数据响应就可以了。 那么，接口交互就成了前后端对接最重要也是最耗时的工作。而提高交互效率的最好的方法就是统一数据格式，后端把数据丢到一个统一的格式中去，前端解析数据也从固定的格式中去取。这样，前端就省去复杂的无关数据解析，能直接拿到想要的数据。后端也只需要把数据丢到固定的格式中去，不用每次都要包装一下。 格式统一 达到...
SpringBoot-如何参数校验、统一异常、统一响应以及自定义注解
子悠のziyou
11-04 421
10分钟快速学会SpringBoot中如何参数校验、统一异常、统一响应以及自定义注解
Spring aop+自定义注解实现接口返回数据过滤
zhouzhou992的博客
06-29 1692
aop+自定义注解作用在方法上进行返回数据过滤。
3.使用注解实现记录接口日志
CAT
03-16 499
功能如下：要求平台登录用户记录操作日志，记录增删改以及接口类型。 思路是在需要记录的地方添加注解，之后再用aop监听此注解，将数据记录到数据表中。 具体如下： 建立自定义注解： //在方法中生效 @Target({ElementType.METHOD}) //在运行过程中生效 @Retention(RetentionPolicy.RUNTIME) @Documented public @in...
如何自定义注解对返回值操作
辰若月煕的博客
03-01 2153
如何自定义注解对返回值操作 第一步 @Inherited @Documented @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.METHOD}) public @interface LogAnnotation { /** * 模块名字 * @return */ String modelName() default ""; /** * 模块类型 * @return
springboot项目controller统一返回对象格式以及全局自定义异常
study_study_know的博客
12-23 1225
@ControllerAdvice与@ExceptionHandler捕获自定义异常，以及封装统一返回值
自定义注解 输出方法上的参数 和 返回值
夜晓星的博客
01-19 9445
定义自定义注解 /**  * 参数日志  * 输出方法上的参数  * 输出返回对象  */ @Target({ ElementType.METHOD, ElementType.TYPE }) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface ParamLog { }     /** ...
SpringBoot自定义注解，统一包装返回值
柳柳柳柳丶的博客
10-28 2584
一：编写统一包装类 package com.llll.demo.model; import lombok.AllArgsConstructor; import lombok.Builder; import lombok.Data; import lombok.NoArgsConstructor; import java.io.Serializable; @Data @Builder @NoArgsConstructor @AllArgsConstructor public class Resp imp
WebAPI接口设计：SwaggerUI文档 / 统一响应格式 / 统一异常处理 / 统一权限验证
weixin_30904593的博客
11-19 449
为什么还要写这类文章？因为我看过网上很多讲解的都不够全面，而本文结合实际工作讲解了swaggerui文档，统一响应格式，异常处理，权限验证等常用模块，并提供一套完善的案例源代码，在实际工作中可直接参考使用。 一、先看看最终效果 这是最后生成的swagerui文档，大家可以直接访问这个地址体验： http://sapi.daimali.com/swagger/ui/index (若无法访问，...
ASP.NET Core Web API处理HttpResponseMessage类型返回值
mihaw的博客
06-09 967
nuget 安装Microsoft.AspNetCore.Mvc.WebApiCompatShim 在startup.cs中 添加 services.AddMvc().AddWebApiConventions();
.Net Core 给WebApi接口返回值添加全局的日期格式化
weixin_30471065的博客
11-17 688
public void ConfigureServices(IServiceCollection services) { services.AddMvc().AddJsonOptions(options => { options.SerializerSettings.DateFormatString = "y...
Spring Boot 统一API接口返回JSON格式教程
资源摘要信息:"Spring Boot 无侵入式 实现API接口统一JSON格式返回" Spring Boot是一个广泛使用的Java框架，用于简化企业级应用开发。它提供了自动配置、嵌入式服务器、安全控制、微服务支持等特性，使得开发者可以...
评论 6
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值