一分钟了解“好”接口的设计与实现

简介: 你见过没有注释的接口么?你见过2000行的接口么?你见过20个参数的接口么?你见过什么更奇葩的接口?

一、好接口的特性

  • 易读
  • 易用,难于误用
  • 功能独立
  • 容易扩展

二、好接口设计的基本原则

  • 只做并做好一件事

函数名自解释

不恰当的函数名,往往是不恰当设计的征兆

  • 如果没做到上一点,就将函数分解

只增加,永远不要删除函数与接口(你永远不知道这个接口被谁在使用)

  • 实现永远不能影响接口

举例:不能假定函数调用者只能使用hash

不能对外暴露实现细节

  • 最小化访问

尽量使用私有化成员

注意信息隐藏

  • 注意文档与注释

接口不是只写给自己(即使只给自己,也应该有说明)

三、好接口实现的基本原则

  • 不要到处拷贝代码
  • 原子性尽量在一个接口内保证
  • Fail-Fast原则

出错尽量早点返回,交给上层处理,不要勉强抢救

  • 避免数据直接访问,而是提供访问方法
  • 注意参数与返回值类型

尽量明确类型

能不用string尽量不用

使用float的地方尽量用double,64bit

  • 参数个数不宜太多

如果过多,就要考虑接口的合理性了

你见过没有注释的接口么?

你见过2000行的接口么?

你见过20个参数的接口么?

你见过什么更奇葩的接口?

目录
相关文章
|
Go Docker 容器
Docker部属Nsq集群
  用一了段时间NSQ还是很稳定的。除了稳定,还有一个特别值的说的就是部署非常简单。总想写点什么推荐给大家使用nsq来做一些东西。但是就是因为他太简单易用,文档也比较简单易懂。一直不知道要写啥!!!!!   nsq官网: http://nsq.io/      为了容灾需要对nsqd多机器部属,有了Docker后,快速扩还是很方便的。
5463 1
|
云安全 安全 网络安全
|
5天前
|
JavaScript 安全 前端开发
Nodejs Brotli decoder 代码执行漏洞 (CVE-2026-111497)10629
Node.js发布安全更新修复Brotli解码器高危RCE漏洞(CVE-2026-111497),建议受影响版本用户立即升级。
1929 1
|
11天前
|
人工智能 API 开发工具
DeepSeek Harness 神插件:白嫖 13 家大厂模型
`dsh-our-free-model` 是 DeepSeek Harness 神级插件:零配置、零API Key、零账号,聚合13家大厂免费模型(含DeepSeek V4.1 Flash、Kimi K3等),支持本地网关、用量看板与自动降级,真正实现“白嫖即用”。
1866 38
|
8天前
|
Web App开发 人工智能 前端开发
2026 年 AI 浏览器怎么选?Ego Lite、Tabbit、Chrome DevTools MCP 深度对比,开发者到底该用哪个?
2026年AI浏览器选型指南:Ego Lite专注多Agent协同(Mac优先),Tabbit国产首选,原生支持Windows与Codex控制;Chrome DevTools MCP非浏览器而是开发者利器,深度集成Console/Network/Performance调试能力,让AI真正“看懂并验证”前端代码。
1209 3
|
5天前
|
安全 应用服务中间件 Go
PHP2Shell 漏洞拆解:WordPress 与 nginx 为何中招
PHP2Shell 双 RCE 已遭在野利用:WordPress、Drupal 全在射程内,nginx 其实另有洞。拆成因与修复顺序
PHP2Shell 漏洞拆解:WordPress 与 nginx 为何中招
|
12天前
|
JSON 程序员 数据格式
最新版Notepad++下载、安装、配置保姆级教程(附官网安装包)
Notepad++ 是一款免费开源、轻量快速的 Windows 文本编辑器,支持多标签、语法高亮、代码折叠与宏录制,体积小、启动快、资源占用低,兼容 x64/x32/ARM 架构,是程序员和文字工作者的高效利器。
1807 0
|
12天前
|
安全 Linux 芯片
【万字长文】Ollama下载、安装、配置、使用保姆级教程(2026最新图解)
Ollama 是一款免费开源的本地大模型运行工具,支持 DeepSeek、Qwen 等主流模型,一条命令即可下载运行。2026 最新版 v0.35.1 官方安装包(1.47GB)已提供国内直连下载,纯本地、离线可用、无广告、无隐私泄露风险。
1144 4

热门文章

最新文章