一:定义响应码枚举 package com.example.demo.core.ret; /** * @Description: 响应码枚举,参考HTTP状态码的语义 * @author * @date 2018/4/19 09:42 */ public enum RetCode { // 成功 SUCCESS(200), // 失败 FAIL(400), // 未认证(签名错误) UNAUTHORIZED(401), // 接口不存在 NOT_FOUND(404), // 服务器内部错误 IN

为什么还要写这类文章?因为我看过网上很多讲解的都不够全面,而本文结合实际工作讲解了swaggerui文档,统一响应格式,异常处理,权限验证等常用模块,并提供一套完善的案例源代码,在实际工作中可直接参考使用. 一.先看看最终效果 这是最后生成的swagerui文档,大家可以直接访问这个地址体验: http://sapi.daimali.com/swagger/ui/index (若无法访问,请公众号CodeL联系) git源码地址:https://gitee.com/daimali/WebApiD

ServerResponse(服务器统一响应数据格式) 前言: 其实严格来说,ServerResponse应该归类到common包中.但是我实在太喜欢这玩意儿了.而且用得也非常频繁,所以忍不住推荐一下. 借此机会,申明一点,这个系列的类并不是都是我原创的,都是我从各个项目中看到的,感觉非常赞,一点点攒起来的.当然后面也有我自己写的一些工具.重要的是学习,从中学习到知识,就算脱离了这些工具,我们也可以自己写一个. 场景: 这个场景我真的觉得只要写过接口的,都需要这个. 其实,在刚刚接触代码的时候,

传统实现 在搭建 Web API 服务的时候,针对客户端请求,我们一般都会自定义响应的 JSON 格式,比如: { "Data" : { "Id" : 100, "Name" : "Robin" }, "ErrorMessage" : "错误消息" } 在基于 ASP.NET Web API 的应用程序,我们一般会创建一个相应结构的 C# 类,如下: public class ApiRe

-Spring Boot返回数据及异常统一封装 -企业实战之spring项目<接口响应体格式统一封装> -Spring Boot fastjson替换jackson -java web项目发布到tomcat时配置不打包jar的方案 -使用Hibernate-Validator优雅的验证RESTful Web Services的参数 -自定义注解实现入参指定枚举值校验

1 要求 每个请求成功后,后台返回的响应格式都是一致的,例如: 2 创建一个视图模型 该模型用于格式化响应数据 package cn.xiangxu.springboottest.model.dataViewModel; import lombok.Data; @Data public class ResultViewModel<T> { private Integer code; private String message; private T data; } 3 创建一个视图模型工具类

spring boot / cloud (二) 规范响应格式以及统一异常处理 前言 为什么规范响应格式? 我认为,采用预先约定好的数据格式,将返回数据(无论是正常的还是异常的)规范起来,有助于提高团队间接口对接的效率(前端和后端,后端和后端等). 思路 自定义统一的ResposeBody类 : 用于统一响应格式 自定义统一的Error类 : 用于统一异常格式 自定义异常 : 区分不同场景的异常 实现ExceptionHandler : 用于拦截处理异常 实现 1.创建ErrorResult类 p

上手就来 新建一个模型验证过滤器,其中ApiResp是自定义的统一响应类. public class VldFilter:IActionFilter { /// <summary> /// 执行到action时 /// </summary> /// <param name="context"></param> public void OnActionExecuting(ActionExecutingContext context) { i

前言 在web应用中,请求处理时,出现异常是非常常见的.所以当应用出现各类异常时,进行异常的捕获或者二次处理(比如sql异常正常是不能外抛)是非常必要的,比如在开发对外api服务时,约定了响应的参数格式,如respCode.respMsg,调用方根据错误码进行自己的业务逻辑.本章节就重点讲解下统一异常和数据校验处理. springboot中,默认在发送异常时,会跳转值/error请求进行错误的展现,根据不同的Content-Type展现不同的错误结果,如json请求时,直接返回json格式参数.

都说管理的精髓就是“制度管人,流程管事”.而所谓流程,就是对一些日常工作环节.方式方法.次序等进行标准化.规范化.且不论精不精髓,在技术团队中,对一些通用场景,统一规范是必要的,只有步调一致,才能高效向前.如前后端交互协议,如本文探讨的异常处理. 1. Spring Mvc中的异常处理 在spring mvc中,跟异常处理的相关类大致如下 上图中,spring mvc中处理异常的类(包括在请求映射时与请求处理过程中抛出的异常),都是 HandlerExceptionResolver 接口的实现,

package com.gsww.chis.aop; import java.util.Arrays; import com.google.common.base.Throwables; import com.gsww.chis.pojo.pacs.PacswsLog; import com.gsww.chis.service.pacs.PacswsLogService; import com.gsww.chis.util.TimeHelper; import org.aspectj.lang.

前言 现在我们做项目基本上中大型项目都是选择前后端分离,前后端分离已经成了一个趋势了,所以总这样·我们就要和前端约定统一的api 接口返回json 格式, 这样我们需要封装一个统一通用全局 模版api返回格式,下次再写项目时候直接拿来用就可以了 约定JSON格式 一般我们和前端约定json格式是这样的 { "code": 200, "message": "成功", "data": { } } code: 返回状态码 messa

前言 由于返回json api 格式接口,所以我们需要通过java bean封装一个统一数据返回格式,便于和前端约定交互, 状态码枚举ResultCode package cn.soboys.core.ret; import lombok.Getter; /** * @author kenx * @version 1.0 * @date 2021/6/17 15:35 * 响应码枚举,对应HTTP状态码 */ @Getter public enum ResultCode { SUCCESS(20

1.背景 在实际开发中,我可能会对请求接口做统一日志输出,或者统一参数解析,验签,统一响应加密等,通常会用到aop,实际案例如下 2.代码 package com.qianxingniwo.log; import com.alibaba.fastjson.JSON; import com.qianxingniwo.exception.ParamException; import org.aspectj.lang.JoinPoint; import org.aspectj.lang.Proceed

Springboot min -Solon 详解系列文章: Springboot mini - Solon详解(一)- 快速入门 Springboot mini - Solon详解(二)- Solon的核心 Springboot mini - Solon详解(三)- Solon的web开发 Springboot mini - Solon详解(四)- Solon的事务传播机制 Springboot mini - Solon详解(五)- Solon扩展机制之Solon Plugin Springbo

Solon Web 开发 一.开始 二.开发知识准备 三.打包与运行 四.请求上下文 五.数据访问.事务与缓存应用 六.过滤器.处理.拦截器 七.视图模板与Mvc注解 八.校验.及定制与扩展 九.跨域处理 十.签权 十一.国际化 十二.统一的渲染控制 十三.WebSocket 十四.与Spring.Jsr330的常用注解对比 下面这个场景是特意为此文设计出来的,有点儿乱.但凡类似的场景...Solon 都可以给你一个so easy的支持. Solon 特性之一: 可让控制器实现 Render,从

*:first-child { margin-top: 0 !important; } body > *:last-child { margin-bottom: 0 !important; } a { color: #4183C4; } a.absent { color: #cc0000; } a.anchor { display: block; padding-left: 30px; margin-left: -30px; cursor: pointer; position: absolute

一个具有REST风格项目的基本特征: 具有统一响应结构 前后台数据流转机制(HTTP消息与Java对象的互相转化机制) 统一的异常处理机制 参数验证机制 Cors跨域请求机制 鉴权机制 一:统一响应结构 使用REST框架实现前后端分离架构,我们需要首先确定返回的JSON响应结构是统一的,也就是说,每个REST请求将返回相同结构的JSON响应结构.不妨定义一个相对通用的JSON响应结构,其中包含两部分:元数据与返回值,其中,元数据表示操作是否成功与返回值消息等,返回值对应服务端方法所返回的数据.该

利用枚举封装返回码和返回信息 package com.template.project.util; public enum StatusCode { SUCCESS(20000, "成功"), FAIL(50000, "失败"), REQUEST_PARAM_ERROR(50001, "请求参数错误"); private int code; private String message; StatusCode(int code, String m

导读 今天和大家聊一下在采用Spring Cloud进行微服务架构设计时,微服务之间调用时异常处理机制应该如何设计的问题.我们知道在进行微服务架构设计时,一个微服务一般来说不可避免地会同时面向内部和外部提供相应的功能服务接口.面向外部提供的服务接口,会通过服务网关(如使用Zuul提供的apiGateway)面向公网提供服务,如给App客户端提供的用户登陆.注册等服务接口. 而面向内部的服务接口,则是在进行微服务拆分后由于各个微服务系统的边界划定问题所导致的功能逻辑分散,而需要微服务之间彼此提供内