java接口设计需要考虑哪些方面

1.签名
目的:防止数据被篡改
(1)接口请求方将请求参数、时间戳和密钥拼接成一个字符串。
(2)使用MD5等hash算法生成签名。
(3)在请求参数或请求头中增加sign参数传递给API接口。
(4)API接口网关服务验证传递的sign值,与自己生成的sign值对比,若相等则认为是有效请求。
时间戳的作用:防止同一次请求被反复利用,增加密钥被破解的可能性,每次请求设置合理的过期时间。

2.加密
目的:保护重要数据(如密码、银行卡号等)。
方法:
(1)使用AES对称加密算法。
(2)在前端使用公钥加密用户密码。
(3)在注册接口中使用密钥解密并作相关权限校验。

3.IP白名单
目的:防止恶意请求。
方法:
(1)限制请求IP。
(2)添加IP白名单在API网关服务上。
(3)防止内部服务器被攻破,需增加web防火墙(如ModSecurity)。

4.限流
目的:防止API接口被频繁调用导致服务不可用。
方法:
(1)对请求IP、请求接口、请求用户作限流。
(2)使用Nginx、Redis或Gateway实现限流。

5.参数校验
目的:拦截无效请求、保护系统资源。
方法:
(1)校验字段是否为空、字段类型、字段长度、枚举值等。
(2)使用Hibernate Validator框架进行校验(如@Size、@Length、@Max等)。

6.统一返回值。
目的:避免返回值结构不统一,便于接口维护。
方法:
所有异常通过API网关捕获并转换成统一的异常结构返回。

7.统一封装异常
目的:防止泄露敏感信息。

8.记录请求日志
目的:便于快速分析和定位问题。
方法:
(1)记录请求url、参数、头信息、请求方式、响应数据和响应时间等。
(2)使用traceId(微服务调用的场景)串联整个请求日志。

9.幂等设计。
目的:防止用户多次请求产生错误数据。
方法:
(1)业务唯一id。
(2)token机制。业务调用接口前先获取token,然后调用业务接口请求时,把token携带过去,服务端判断token是否存在redis中,存在则表示第一次请求,可以继续执行业务,执行完成后把redis中的token删除。
(3)建去重表。
(4)版本控制。增加版本号,当版本号符合时,才去处理数据。
(5)状态控制。根据业务的状态判断是否已经处理。

10.限制记录条数。
目的:避免接口超时问题。

11.压测
目的:了解各接口的QPS情况,确保上线后接口的稳定性。
方法:
使用jmeter或apache bench进行压力测试。

12.异步处理
目的:提升复杂业务逻辑的接口性能
方法:
(1)使用消息中间件。接口发送MQ消息后立即返回成功,消息由MQ消费者异步处理。
(2)使用线程池。直接提交线程池,由线程池去进行异步处理。

13.数据脱敏
目的:保护敏感数据,防止泄露隐私。
方法:
对返回的一些个人敏感信息,比如手机号、邮箱等做部分屏蔽处理。

14.职责单一
目的:降低接口维护成本
方法:
接口设计应该职责单一、避免复杂的if…else判断。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/bicheng/26166.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

内部人员随意上传涉密数据,对国家安全造成严重威胁

对数据采取有效措施,守住“云”安全! 近年来,随着网络“云”功能不断普及,“云端”数据也成为了境外间谍情报机关关注的重点,他们通过网络攻击、植入木马等各种手段,试图窃取我国敏感信息和涉密数据&#…

企业微信应用 应用号内消息链接无法在企微内置浏览器打开 windows PC客户端 问题解决

问题 需求是每周在企微的应用号上发送周报,周报中会带着进入系统的链接,点击进入可以查看详情。系统需要登录鉴权,因此需要在内置浏览器打开便于自动认证。 但是,在企微应用号发送的链接,手机上可以正常使用企微内置…

Apache Hadoop的核心组成及其架构

核心组成 Apache Hadoop 是一个开源的分布式存储与计算框架,它主要由以下几个核心组件组成: Hadoop Distributed File System (HDFS): HDFS 是 Hadoop 的分布式文件系统,它设计用于存储大量数据,并提供 高吞吐率的数据访问,通过将数据分块存储在多个节点上,实现数据的冗…

Web前端教学大纲:深入探索与实践之旅

Web前端教学大纲:深入探索与实践之旅 Web前端技术,作为互联网世界的门面,承载着展示信息、交互体验的重要使命。对于初学者而言,掌握一份系统、全面且具备深度的教学大纲,无疑能为其在前端领域的探索之旅提供有力的指…

AVL树 ---(C++)

本篇讲全面的讲解 AVL 树的插入,旋转以及验证 AVL 树的性能(本篇未实现删除代码)。至于为什么会有 AVL 树,这是因为简单的二叉搜索树并不能直接的保证搜索的效率,因为当我们在二叉搜索树中插入一段有序的序列的时候&am…

盛元广通微生物实验室质控菌株管理系统

盛元广通微生物实验室质控菌株管理系统广泛应用于生物医药、基因工程、环境科学、食品工业、农业等领域。该系统是一个包含菌株信息录入、库存管理、鉴定检验、使用记录管理等功能在内的综合性系统。实验室可以实现对质控菌株的规范化、标准化管理,确保实验结果的准…

NLP--朴素贝叶斯

1.在很多时候,我们不能像抛硬币一样通过客观性的方式来得到正反面的概率,而是常常遇到主观性的概率时,我们就不得不提及贝叶斯学派。贝叶斯概率是一种对概率的解释。概率被解释为代表一种具备某种知识状态的合理预期。因此,贝叶斯…

数字化医疗:揭秘物联网如何提升医院设备管理效率!

在当今数字化时代,医疗领域正迎来一场技术变革的浪潮,而基于物联网的智慧医院医疗设备管理体系正是这场变革的闪耀之星。想象一下,医院里的每一台医疗设备都能像一位精密的工匠一样,自动监测、精准诊断,甚至在发生故障…

问题:设开环系统的频率特性为则其相频特性穿越-180°线时对应的频率为()。 #学习方法#微信

问题:设开环系统的频率特性为则其相频特性穿越-180线时对应的频率为()。 ? A、10rad1s B、3rad/s C、lradIs D、√3rad/s 参考答案如图所示

哈喽GPT-4o——对GPT-4o Prompt的思考与看法

目录 一、提示词二、提示词的优势1、提升理解能力2、增强专注力3、提高效率 三、什么样的算无效提示词?1、过于宽泛2、含糊不清3、太过复杂4、没有具体上下文5、缺乏明确目标6、过于开放7、使用专业术语但未定义8、缺乏相关性: 四、提示词正确的编写步骤…

C++第二十六弹---stack和queue的基本操作详解与模拟实现

✨个人主页: 熬夜学编程的小林 💗系列专栏: 【C语言详解】 【数据结构详解】【C详解】 目录 1. stack的介绍和使用 1.1 stack的介绍 ​1.2 stack的使用 1.3 stack 模拟实现 2. queue的介绍和使用 2.1 queue的介绍 2.2 queue的使用 2…

R语言:使用 readr 包进行数据导入和解析

readr 包是 R 语言中专门用于读取和写入各种格式数据文件的工具包。本文将总结 readr 包的常见数据文件类型、获取/修改工作路径的方法,以及数据的读取与写入功能,最后还会介绍一些解析函数的用法。 1. 常见数据文件类型 readr 包支持多种常见的数据文…

计算机组成原理之计算机的性能指标

目录 计算机的性能指标 复习提示 1.计算机的主要性能指标 1.1机器字长 1.1.1与机器字长位数相同的部件 1.2数据通路带宽 1.3主存容量 1.4运算速度 1.4.1提高系统性能的综合措施 1.4.2时钟脉冲信号和时钟周期的相关概念 1.4.3主频和时钟周期的转换计算 1.4.4IPS的相关…

论文写作革新:AI如何简化你的研究流程?

不知道大家有没有发现,随着人工智能技术的快速发展,AI工具正逐渐渗透到我们日常生活的各个方面,极大地提高了我们的工作和学习效率。无论是AI写作、AI绘画、AI思维导图,还是AI幻灯片制作,这些工具已成为我们不可或缺的…

学会python——文本分词(python实例一)

目录 1、认识Python 2、环境与工具 2.1 python环境 2.2 pycharm编译 3、对文本进行分词 3.1 代码构思 3.2 代码示例 3.3 运行结果 4、总结 1、认识Python Python 是一个高层次的结合了解释性、编译性、互动性和面向对象的脚本语言。 Python 的设计具有很强的可读性&a…

C++面向对象程序设计 - 异常处理

在C发展后期,加了一些功能,作为工具来使用,其中主要有模板(包括函数模板和类模板)、异常处理、命名空间和运行时类型识别,以帮助程序设计人员更方便地进行程序设计和调试工作。 程序中常见的错误有两大类&a…

分布式CAP、BASE理论务必了解一下

分布式系统理论是计算机科学中的一个重要分支,它关注如何设计和实现能够跨多个物理或逻辑位置运行的系统。在分布式系统中,CAP定理和BASE理论是两个非常著名的理论,它们分别描述了分布式系统设计中的一些基本约束和原则。 CAP定理 CAP定理&…

【天池科普】1. 为啥人人都要学AI

大家好!欢迎来到天池的AI科普系列课程,本期是第一期内容。在这个信息爆炸的时代,人工智能(AI)不仅是技术进步的标志,更是推动社会向前发展的强大引擎。无论你是AI领域的新手,还是有一定基础的学…

ER实体关系图与数据库模型图绘制

属性分析 1、用户表(user)、用户钱包表(user_wallet)(与user是1对1关系)、用户钱包交易日志表(user_wallet_log)(与user是1对多关系)。 user:用户表通常包含用户的基本信息,例如用户ID(主键)、用户名、密码(通常加密…

【Three.js】知识梳理二:Three.js引用和环境搭建

1.文件包下载和目录简介 1.1 文件包下载 a. 官方网站下载: 访问 Three.js 的官方网站(threejs.org/)并点击 "Download" 按钮,下载最新版本的文件包。 b. GitHub仓库下载: 访问 Three.js 的 GitHub 仓库&a…