从0到1开发测试平台(九)后端对接口response的封装
时间:2022-07-23
本文章向大家介绍从0到1开发测试平台(九)后端对接口response的封装,主要内容包括其使用实例、应用技巧、基本知识点总结和需要注意事项,具有一定的参考价值,需要的朋友可以参考一下。
在进行接口开发时,一般需要一个固定的返回样式,成功和失败的时候,都按照这种格式来进行统一的返回,这样,在与其他人进行接口之间的联调时不会显得很杂乱无章,并且前端方便对返回结果统一处理。而这种固定的格式如果放在Java的每个接口单独处理时,又会在接口开发时很繁琐,所以这个时候可以采用封装一个实体类,统一返回固定模板格式的内容。
现在对我们之前写的登录接口返回进行统一封装处理。
新建common包,并且在common包里新建StatusCode.java,这个类主要是统一定义程序里用到的错误码
package com.caomingyu.cctestplatform.common;
public class StatusCode {
//请登录
public static final Integer NEED_LOGIN = 401;
/** 操作成功*/
public static final Integer OPERATIONSUCCESS = 200;
/** 用户名/密码错误*/
public static final Integer USER_NAME_OR_PASSWORD_EORROR = 1011;
/** 用户不存在*/
public static final Integer USER_NOT_EXIST = 1012;
/** 用户名不能为空*/
public static final Integer USER_NAME_NULL = 1013;
/** 密码不能为空*/
public static final Integer USER_PASS_NULL = 1014;
}
在common包里新建ResultType.java,这个类是用来定义相应错误码对应的话术
package com.caomingyu.cctestplatform.common;
public class ResultType {
public static final String NEED_LOGIN = "温馨提示:请使用对应的账号登录";
public static final String LOGIN_SUCCESS = "登录成功";
public static final String USER_NAME_OR_PASSWORD_EORROR = "用户名/密码错误";
public static final String USER_NOT_EXIST = "用户不存在";
public static final String USER_NAME_NULL = "用户名不能为空";
public static final String USER_PASS_NULL = "密码不能为空";
}
在bean包新建Page.java和Result.java,其中page是用来返回分页信息的,Result是统一返回结果
package com.caomingyu.cctestplatform.bean;
import lombok.Data;
import org.springframework.stereotype.Component;
/**
* Created by caomingyu on 2019/2/17.
*/
@Data
@Component
public class Page {
private static final long serialVersionUID = 1L;
private int pageNum;
private int pageSize;
private int startRow;
private int endRow;
private long total;
private int pages;
private boolean count;
private Boolean reasonable;
private Boolean pageSizeZero;
private String countColumn;
private String orderBy;
private boolean orderByOnly;
}
package com.caomingyu.cctestplatform.bean;
import com.caomingyu.cctestplatform.common.StatusCode;
import lombok.Data;
import java.io.Serializable;
@Data
public class Result implements Serializable {
/** 成功失败 */
private boolean success;
/** 状态码 */
private Integer code;
/** 返回结果集 */
private Object data;
/** 信息 */
private String message;
/**分页信息 */
private Page pageInfo;
/** 前端弹窗模式:"warning", "error", "success", "info" */
private String icon;
public Result() {}
public Result(boolean success, String message) {
this.success = success;
this.message = message;
if (success) icon = "success";
else icon = "error";
}
public Result(boolean success, Integer code, String message) {
this(success, message);
this.code = code;
}
public Result(boolean success, Integer code, Object data, String message) {
this(success, code, message);
this.data = data;
}
public static Result result(Object data, boolean success, Integer code, String message) {
Result result = new Result();
result.data = data;
result.success = success;
result.message = message;
result.code = code;
return result;
}
public static Result result(Object data, Page pageInfo, boolean success, Integer code, String message) {
Result result = new Result();
result.pageInfo = pageInfo;
result.data = data;
result.success = success;
result.message = message;
result.code = code;
return result;
}
//返回成功结果
public static Result resultSuccess(Page pageInfo, Object data, String message) {
Result result = new Result();
result.success = true;
result.code = StatusCode.OPERATIONSUCCESS;
result.message = message;
result.pageInfo = pageInfo;
result.data = data;
return result;
}
//返回失败
public static Result resultError(String message, int code) {
Result result = new Result();
result.success = false;
result.message = message;
result.code = code;
return result;
}
public Object getData() {
return data;
}
public void setData(Object data) {
this.data = data;
}
public boolean isSuccess() {
return success;
}
public void setSuccess(boolean success) {
this.success = success;
}
public String getMessage() {
return message;
}
public void setMessage(String message) {
this.message = message;
}
public Integer getCode() {
return code;
}
public void setCode(Integer code) {
this.code = code;
}
public String getIcon() {
return icon;
}
public void setIcon(String icon) {
this.icon = icon;
}
public Page getPageInfo() {
return pageInfo;
}
public void setPageInfo(Page pageInfo) {
this.pageInfo = pageInfo;
}
}
对UserController.java和UserServiceImpl.java中的login方法进行统一返回的修改
package com.caomingyu.cctestplatform.controller;
import com.caomingyu.cctestplatform.bean.Result;
import com.caomingyu.cctestplatform.bean.User;
import com.caomingyu.cctestplatform.common.ResultType;
import com.caomingyu.cctestplatform.common.StatusCode;
import com.caomingyu.cctestplatform.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/api/v1/user")
public class UserController {
@Autowired
private UserService userService;
@PostMapping("/login")
public Result login(@RequestBody User user){
if (user == null){
return Result.resultError(ResultType.USER_NAME_NULL, StatusCode.USER_NAME_NULL);
}
if (user.getUserName() == null || "".equals(user.getUserName())){
return Result.resultError(ResultType.USER_NAME_NULL, StatusCode.USER_NAME_NULL);
}
if (user.getPassword() == null || "".equals(user.getPassword())){
return Result.resultError(ResultType.USER_PASS_NULL, StatusCode.USER_PASS_NULL);
}
return userService.login(user.getUserName(), user.getPassword());
}
}
package com.caomingyu.cctestplatform.service.impl;
import com.caomingyu.cctestplatform.bean.Result;
import com.caomingyu.cctestplatform.bean.User;
import com.caomingyu.cctestplatform.common.ResultType;
import com.caomingyu.cctestplatform.common.StatusCode;
import com.caomingyu.cctestplatform.dao.UserDao;
import com.caomingyu.cctestplatform.service.UserService;
import com.caomingyu.cctestplatform.util.Md5Utils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
@Service
public class UserServiceImpl implements UserService {
@Autowired
private UserDao userDao;
@Override
public User queryUserByName(String userName) {
return userDao.queryUserByName(userName);
}
@Override
public Result login(String userName, String password) {
User user = queryUserByName(userName);
if (user == null){
return Result.resultError(ResultType.USER_NOT_EXIST, StatusCode.USER_NOT_EXIST);
}
String passwordParam = Md5Utils.string2MD5(password);
if (!passwordParam.equals(user.getPassword())){
return Result.resultError(ResultType.USER_NAME_OR_PASSWORD_EORROR, StatusCode.USER_NAME_OR_PASSWORD_EORROR);
}
return Result.resultSuccess(null,null,ResultType.LOGIN_SUCCESS);;
}
}
- 一组扁平化组件推荐下载(PSD 格式)
- [C#6] 6-表达式形式的成员函数
- 在启用了IPV6的机器上获取客户端ipv4地址
- 使用 MDT 2010 进行可伸缩部署
- 性能优化工具 MVC Mini Profiler
- 在ASP.NET应用启动的时候初始化的几种方法
- [C#6] 8-异常增强
- 信息超新星的诞生
- jquery mobile 移动web(2)
- [腾讯社区开放平台].NET SDK基于New BSD协议开源
- IIS7.5上的REST服务的Put操作发生HTTP Error 405.0 - Method Not Allowed 解决方法
- 使用 asp.net mvc和 jQuery UI 控件包
- jquery mobile 移动web(1)
- WordPress Plugin Boilerplate:一个WordPress 插件开发模板(框架)
- JavaScript 教程
- JavaScript 编辑工具
- JavaScript 与HTML
- JavaScript 与Java
- JavaScript 数据结构
- JavaScript 基本数据类型
- JavaScript 特殊数据类型
- JavaScript 运算符
- JavaScript typeof 运算符
- JavaScript 表达式
- JavaScript 类型转换
- JavaScript 基本语法
- JavaScript 注释
- Javascript 基本处理流程
- Javascript 选择结构
- Javascript if 语句
- Javascript if 语句的嵌套
- Javascript switch 语句
- Javascript 循环结构
- Javascript 循环结构实例
- Javascript 跳转语句
- Javascript 控制语句总结
- Javascript 函数介绍
- Javascript 函数的定义
- Javascript 函数调用
- Javascript 几种特殊的函数
- JavaScript 内置函数简介
- Javascript eval() 函数
- Javascript isFinite() 函数
- Javascript isNaN() 函数
- parseInt() 与 parseFloat()
- escape() 与 unescape()
- Javascript 字符串介绍
- Javascript length属性
- javascript 字符串函数
- Javascript 日期对象简介
- Javascript 日期对象用途
- Date 对象属性和方法
- Javascript 数组是什么
- Javascript 创建数组
- Javascript 数组赋值与取值
- Javascript 数组属性和方法
- Spark Kafka 基于Direct自己管理offset
- 使用Reactor响应式编程
- 多场景下MySQL临时表的作用
- Flink 自定义触发器实现带超时时间的 CountWindow
- 聊聊Spring Boot Actuator
- [译]按功能(特性)分包
- Spring Boot Admin简介及实践
- Spring Boot Admin实现服务健康预警
- 除了FastJson,你也应该了解一下Jackson(二)
- 除了FastJson,你也应该了解一下Jackson(一)
- JavaScript性能优化总结
- Spring Boot2+Resilience4j实现容错之Bulkhead
- [译]高性能缓存库Caffeine介绍及实践
- 云原生时代高性能Java框架—Quarkus(一)
- 云原生时代高性能Java框架—Quarkus(二)