如何优雅的使用后端接口

这篇具有很好参考价值的文章主要介绍了如何优雅的使用后端接口。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

优雅的后端接口

一个后端接口大致分为四个部分:接口地址(url)、接口请求方式(get、post等)、请求数据(request)、响
应数据(response)。
一、URL & Method
Rest 设计风格 ===》 Restful API
简单理解: URI 是用来唯一标志一个互联网资源;Method 是用来标识当前请求对该资源进行什么操
作。
版本号、状态码、过滤信息、ContentType、Cookie 。。。
二、请求参数

1. 参数校验

比较常见的做法,在业务层进行参数校验:

POST /users
GET /users/{user_id}
PUT /users/{user_id}
DELETE /users/{user_id}
public String addUserV1(UserDTO userDTO) {
if (userDTO == null
|| userDTO.getId() == null
|| userDTO.getAccount() == null
|| userDTO.getEmail() == null
|| userDTO.getPassword() == null) {
return "对象或者对象字段不能为空";
}
if (StrUtil.isEmpty(userDTO.getAccount())
|| StrUtil.isEmpty(userDTO.getPassword())
|| StrUtil.isEmpty(userDTO.getEmail())) {
return "不能输入空字符串";
}
if (userDTO.getAccount().length() < 6 ||
userDTO.getAccount().length() > 11) {
return "账号长度必须是6-11个字符";
}
if (userDTO.getPassword().length() < 6 ||
userDTO.getPassword().length() > 11) {
}

不能说有什么错,而且格式排版整齐还一目了然,但是。。。。太繁琐!

2. Validator + BindResult

接下来只需要在接口需要校验的参数上加上 @valid 注解,并添加 BindResult 参数即可完成验证。
但是。。。每个接口都要添加 BindingResultResult 还是很烦!

3. Validator + 自动抛出异常

return "密码长度必须是6-11个字符";
}
if (!Pattern.matches("^[0-9a-zA-Z]+\\w*@([0-9a-zA-Z]+\\.)+[0-9a-zAZ]+$", userDTO.getEmail())) {
return "邮箱格式不正确";
}
return "success";
}
import javax.validation.constraints.Email;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;
@Data
public class UserDTO {
@NotNull(message = "用户id不能为空")
private Integer id;
@NotNull(message = "用户账户不能为空")
@Size(min = 6, max = 11, message = "账户长度必须是6-11个字符")
private String account;
@NotNull(message = "用户密码不能为空")
@Size(min = 6, max = 11, message = "账户密码必须是6-11个字符")
private String password;
@NotNull(message = "用户邮箱不能为空")
@Email(message = "邮箱格式不正确")
private String email;
}
@PostMapping("/v2/user")
public String addUserV2(@RequestBody @Valid UserDTO userDTO, BindingResult
bindingResult) {

// 如果有参数校验失败,会将错误信息封装成对象组装在 BindingResult 里

for (ObjectError error : bindingResult.getAllErrors()) {
return error.getDefaultMessage();
}
return userService.addUserV1(userDTO);
}

没有最好的标准,但是一个规范的接口肯定比没有约束的接口要来的优雅。文章来源地址https://www.toymoban.com/news/detail-623510.html

@PostMapping("/v3/user")
public String addUserV3(@RequestBody @Valid UserDTO userDTO) {
return userService.addUserV1(userDTO);
}

到了这里,关于如何优雅的使用后端接口的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 代码优雅之道——Java如何判空?

    实际项目中我们会有很多地方需要判空校验,如果不做判空校验则可能产生NullPointerException异常。 针对异常的处理我们在上一篇有提及: 先来看一下实际项目中一些判空方式 通常我们判断一个对象是否为Null,可以使用java.util中的Objects.nonNull(obj)、hutool中的ObjectUtil或者直接

    2024年02月15日
    浏览(80)
  • Linux中如何安装java环境(纯干货无废话)

    下载地址:https://www.oracle.com/java/technologies/downloads/#java8 本篇以jdk1.8.0_171为例 使用 vim /etc/profile ,在文件尾部添加以下代码: 执行这段代码为了让上一步添加的代码生效 恭喜你已经安装好了!

    2024年02月07日
    浏览(37)
  • 如何在 容器中 优雅的 运行 java 应用

    当需要运行Java应用时,不管在机器上还是容器里,一般的做法是运行 java 命令。 java -jar /opt/app.jar 即可 如果是多多jar 文件的只需用到 java -cp lib/* com.example.Main 定类路径(classpath)和入口 Java 类即可。 但 在构建容器镜像时,一般使用 Dockerfile 的 ENTRYPOINT 来指定运行的 java 命

    2024年02月15日
    浏览(40)
  • Java如何优雅地判断对象是否为空

    点击下载《Java如何优雅地判断对象是否为空》 在实际项目中,我们经常需要对各种变量或对象进行判空校验。这是因为,如果不进行判空校验,当遇到空值时,可能会导致程序出现NullPointerException异常。这是一种常见的运行时异常,它会在试图访问或操作空对象引用时发生。

    2024年04月28日
    浏览(97)
  • Java后端接口返回视频流,使用video组件播放视频,实现分段下载

    视频文件保存在不为人知的地方,总之前端不能直接访问的位置,需要通过后端接口取出来再返回给前端。 前端这样子播放 src=后端接口 如果后端直接这样子写 小视频问题不大,视频大的话会卡顿很久,查看请求发现会先请求下载完整视频后开始播放。而且不能拖动进度条

    2024年02月12日
    浏览(46)
  • Java中如何优雅的把Map转为对象

    在项目开发中,经常碰到map转实体对象或者对象转map的场景,工作中,很多时候我们可能比较喜欢使用第三方jar包的API对他们进行转化,而且用起来也还算方便,比如像fastJson就可以轻松实现map和对象的互转,但这里,我想通过反射的方式对他们做转化,也算是对反射的学习

    2024年02月13日
    浏览(39)
  • JVM安全退出(如何优雅的关闭java服务)

    上线!重启!你还在为丢失任务而烦恼么?看这里看这里,从此不再丢任务,JVM可以安全退出的 在交易流程中,为了提升服务的性能,我们做了一些异步化的优化,比如更新用户最近使用的收货地址、提单完成后通过MQ去发送各种通知类消息、清理用户的购物车等等这些操作,

    2024年03月22日
    浏览(46)
  • 如何使用CFImagehost结合内网穿透搭建私人图床并无公网ip远程访问

    @[TOC] 点击跳转 图片服务器也称作图床,可以说是互联网存储中最重要的应用之一,不仅网站需要图床提供的外链调取图片,个人或企业也用图床存储各种图片,方便随时访问查看。不过由于图床很不挣钱,各互联网大厂正在逐步关停所属的图床服务器,这也导致用户只能自

    2024年01月19日
    浏览(59)
  • 如何使用Imagewheel搭建一个简单的的私人图床无公网ip也能访问

    云存储在前几年风头无两,云存储平台也如雨后春笋般冒出来。但是这两年风头退去云存储平台相继关闭,除了几个互联网大厂,其他平台都在苦苦支撑。而图床作为云存储的一个分支,更是所剩无几。但图床不仅能用来存储个人图片,也能作为网站图片的来源,想要拥有一

    2024年02月01日
    浏览(43)
  • 如何优雅地单元测试 Kotlin/Java 中的 private 方法?

    翻译自 https://medium.com/mindorks/how-to-unit-test-private-methods-in-java-and-kotlin-d3cae49dccd ❓如何单元测试 Kotlin/Java 中的 private 方法❓ 首先,开发者应该测试代码里的 private 私有方法吗? 直接信任这些私有方法,测试到调用它们的公开方法感觉就够了吧。 对于这个争论,每个开发者都会

    2024年02月06日
    浏览(41)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包