From 13820c2730614613153c1e8bdfdfa3b55b4009c4 Mon Sep 17 00:00:00 2001 From: guide Date: Fri, 7 May 2021 15:42:36 +0800 Subject: [PATCH 1/3] =?UTF-8?q?Update=20RESTfulAPI=E7=AE=80=E6=98=8E?= =?UTF-8?q?=E6=95=99=E7=A8=8B.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...00\346\230\216\346\225\231\347\250\213.md" | 82 +++++++++++++------ 1 file changed, 57 insertions(+), 25 deletions(-) diff --git "a/docs/system-design/coding-way/RESTfulAPI\347\256\200\346\230\216\346\225\231\347\250\213.md" "b/docs/system-design/coding-way/RESTfulAPI\347\256\200\346\230\216\346\225\231\347\250\213.md" index 103ba087da4..3eb26b993f8 100644 --- "a/docs/system-design/coding-way/RESTfulAPI\347\256\200\346\230\216\346\225\231\347\250\213.md" +++ "b/docs/system-design/coding-way/RESTfulAPI\347\256\200\346\230\216\346\225\231\347\250\213.md" @@ -1,47 +1,79 @@ -![bd4442aed16acafc54c7943d34abff0edadfa74c](https://my-blog-to-use.oss-cn-beijing.aliyuncs.com/2019-11/bd4442aed16acafc54c7943d34abff0edadfa74c.png) +![](https://img-blog.csdnimg.cn/2021050713553862.png) -大家好我是 Guide 哥！这是我的第 **210** 篇优质原创！这篇文章主要分享了后端程序员必备的 RestFul API 相关的知识。 +大家好，我是 Guide 哥！ -RESTful API 是每个程序员都应该了解并掌握的基本知识，我们在开发过程中设计 API 的时候也应该至少要满足 RESTful API 的最基本的要求（比如接口中尽量使用名词，使用 POST 请求创建资源，DELETE 请求删除资源等等，示例：`GET /notes/id`：获取某个指定 id 的笔记的信息）。 +这篇文章简单聊聊后端程序员必备的 RESTful API 相关的知识。 -如果你看 RESTful API 相关的文章的话一般都比较晦涩难懂，包括我下面的文章也会提到一些概念性的东西。但是，实际上我们平时开发用到的 RESTful API 的知识非常简单也很容易概括！举个例子,如果我给你下面两个 url 你是不是立马能知道它们是干什么的！这就是 RESTful API 的强大之处！ +开始正式介绍 RESTful API 之前，我们需要首先搞清 ：**API 到底是什么？** -**RESTful API 可以你看到 url + http method 就知道这个 url 是干什么的，让你看到了 http 状态码（status code）就知道请求结果如何。** +## 何为 API？ + +![](https://img-blog.csdnimg.cn/20210507153833945.png) + +**API（Application Programming Interface）** 翻译过来是应用程序编程接口的意思。 + +我们在进行后端开发的时候，主要的工作就是为前端或者其他后端服务提供 API 比如查询用户数据的 API 。 + +![](https://img-blog.csdnimg.cn/20210507130629538.png) + +但是， API 不仅仅代表后端系统暴露的接口，像框架中提供的方法也属于 API 的范畴。 + +为了方便大家理解，我再列举几个例子🌰： + +1. 你通过某电商网站搜索某某商品，电商网站的前端就调用了后端提供了搜索商品相关的 API。 +2. 你使用 JDK 开发 Java 程序，想要读取用户的输入的话，你就需要使用 JDK 提供的 IO 相关的 API。 +3. ...... + +你可以把 API 理解为程序与程序之间通信的桥梁，其本质就是一个函数而已。另外，API 的使用也不是没有章法的，它的规则由（比如数据输入和输出的格式）API提供方制定。 + +## 何为 RESTful API？ + +**RESTful API** 经常也被叫做 **REST API**，它是基于 REST 构建的 API。这个 REST 到底是什么，我们后文在讲，涉及到的概念比较多。 + +如果你看 RESTful API 相关的文章的话一般都比较晦涩难懂，主要是因为 REST 涉及到的一些概念比较难以理解。但是，实际上，我们平时开发用到的 RESTful API 的知识非常简单也很容易概括！ + +举个例子，如果我给你下面两个 API 你是不是立马能知道它们是干什么用的！这就是 RESTful API 的强大之处！ ``` GET /classes：列出所有班级 POST /classes：新建一个班级 ``` -下面的内容只是介绍了我觉得关于 RESTful API 比较重要的一些东西，欢迎补充。 +**RESTful API 可以让你看到 URL+Http Method 就知道这个 URL 是干什么的，让你看到了 HTTP 状态码（status code）就知道请求结果如何。** -### 一、重要概念 +像咱们在开发过程中设计 API 的时候也应该至少要满足 RESTful API 的最基本的要求（比如接口中尽量使用名词，使用 `POST` 请求创建资源，`DELETE` 请求删除资源等等，示例：`GET /notes/id`：获取某个指定 id 的笔记的信息）。 -REST,即 **REpresentational State Transfer** 的缩写。这个词组的翻译过来就是"表现层状态转化"。这样理解起来甚是晦涩，实际上 REST 的全称是 **Resource Representational State Transfer** ，直白地翻译过来就是 **“资源”在网络传输中以某种“表现形式”进行“状态转移”** 。如果还是不能继续理解，请继续往下看，相信下面的讲解一定能让你理解到底啥是 REST 。 +## 解读 REST -我们分别对上面涉及到的概念进行解读，以便加深理解，不过实际上你不需要搞懂下面这些概念，也能看懂我下一部分要介绍到的内容。不过，为了更好地能跟别人扯扯 “RESTful API”我建议你还是要好好理解一下！ +**REST** 是 `REpresentational State Transfer` 的缩写。这个词组的翻译过来就是“**表现层状态转化**”。 + +这样理解起来甚是晦涩，实际上 REST 的全称是 **Resource Representational State Transfer** ，直白地翻译过来就是 **“资源”在网络传输中以某种“表现形式”进行“状态转移”** 。如果还是不能继续理解，请继续往下看，相信下面的讲解一定能让你理解到底啥是 REST 。 + +我们分别对上面涉及到的概念进行解读，以便加深理解，实际上你不需要搞懂下面这些概念，也能看懂我下一部分要介绍到的内容。不过，为了更好地能跟别人扯扯 “RESTful API”我建议你还是要好好理解一下！ - **资源（Resource）** ：我们可以把真实的对象数据称为资源。一个资源既可以是一个集合，也可以是单个个体。比如我们的班级 classes 是代表一个集合形式的资源，而特定的 class 代表单个个体资源。每一种资源都有特定的 URI（统一资源标识符）与之对应，如果我们需要获取这个资源，访问这个 URI 就可以了，比如获取特定的班级：`/class/12`。另外，资源也可以包含子资源，比如 `/classes/classId/teachers`：列出某个指定班级的所有老师的信息 -- **表现形式（Representational）**："资源"是一种信息实体，它可以有多种外在表现形式。我们把"资源"具体呈现出来的形式比如 json，xml，image,txt 等等叫做它的"表现层/表现形式"。 +- **表现形式（Representational）**："资源"是一种信息实体，它可以有多种外在表现形式。我们把"资源"具体呈现出来的形式比如 `json`，`xml`，`image`,`txt` 等等叫做它的"表现层/表现形式"。 - **状态转移（State Transfer）** ：大家第一眼看到这个词语一定会很懵逼？内心 BB：这尼玛是啥啊？ 大白话来说 REST 中的状态转移更多地描述的服务器端资源的状态，比如你通过增删改查（通过 HTTP 动词实现）引起资源状态的改变。ps:互联网通信协议 HTTP 协议，是一个无状态协议，所有的资源状态都保存在服务器端。 综合上面的解释，我们总结一下什么是 RESTful 架构： 1. 每一个 URI 代表一种资源； -2. 客户端和服务器之间，传递这种资源的某种表现形式比如 json，xml，image,txt 等等； +2. 客户端和服务器之间，传递这种资源的某种表现形式比如 `json`，`xml`，`image`,`txt` 等等； 3. 客户端通过特定的 HTTP 动词，对服务器端资源进行操作，实现"表现层状态转化"。 -### 二、REST 接口规范 +## REST API 规范 + +![](https://img-blog.csdnimg.cn/20210507154007779.png) -#### 1、动作 +### 动作 -- GET ：请求从服务器获取特定资源。举个例子：`GET /classes`（获取所有班级） -- POST ：在服务器上创建一个新的资源。举个例子：`POST /classes`（创建班级） -- PUT ：更新服务器上的资源（客户端提供更新后的整个资源）。举个例子：`PUT /classes/12`（更新编号为 12 的班级） -- DELETE ：从服务器删除特定的资源。举个例子：`DELETE /classes/12`（删除编号为 12 的班级） -- PATCH ：更新服务器上的资源（客户端提供更改的属性，可以看做作是部分更新），使用的比较少，这里就不举例子了。 +- `GET `：请求从服务器获取特定资源。举个例子：`GET /classes`（获取所有班级） +- `POST` ：在服务器上创建一个新的资源。举个例子：`POST /classes`（创建班级） +- `PUT` ：更新服务器上的资源（客户端提供更新后的整个资源）。举个例子：`PUT /classes/12`（更新编号为 12 的班级） +- `DELETE` ：从服务器删除特定的资源。举个例子：`DELETE /classes/12`（删除编号为 12 的班级） +- `PATCH` ：更新服务器上的资源（客户端提供更改的属性，可以看做作是部分更新），使用的比较少，这里就不举例子了。 -#### 2、路径（接口命名） +### 路径（接口命名） 路径又称"终点"（endpoint），表示 API 的具体网址。实际开发中常见的规范如下： @@ -74,7 +106,7 @@ DELETE classes/classId/teachers/ID：删除某个指定班级下的指定的老 理清资源的层次结构，比如业务针对的范围是学校，那么学校会是一级资源:`/schools`，老师: `/schools/teachers`，学生: `/schools/students` 就是二级资源。 -#### 3、过滤信息（Filtering） +### 过滤信息（Filtering） 如果我们在查询的时候需要添加特定条件的话，建议使用 url 参数的形式。比如我们要查询 state 状态为 active 并且 name 为 guidegege 的班级： @@ -88,7 +120,7 @@ GET /classes?state=active&name=guidegege GET /classes?page=1&size=10 //指定第1页，每页10个数据 ``` -#### 4、状态码（Status Codes） +### 状态码（Status Codes） **状态码范围：** @@ -101,7 +133,7 @@ GET /classes?page=1&size=10 //指定第1页，每页10个数据 | | | 405 请求方法不对 | | -### 三 HATEOAS +## RESTful 的极致 HATEOAS > **RESTful 的极致是 hateoas ，但是这个基本不会在实际项目中用到。** @@ -122,12 +154,12 @@ GET /classes?page=1&size=10 //指定第1页，每页10个数据 在 Spring 中有一个叫做 HATEOAS 的 API 库，通过它我们可以更轻松的创建除符合 HATEOAS 设计的 API。 -### 文章推荐 +## 文章推荐 **RESTful API 介绍：** - [RESTful API Tutorial](https://RESTfulapi.net/) -- [RESTful API 最佳指南](http://www.ruanyifeng.com/blog/2014/05/restful_api.html)（阮一峰，这篇文章大部分内容来源） +- [RESTful API 最佳指南](http://www.ruanyifeng.com/blog/2014/05/RESTful_api.html)（阮一峰，这篇文章大部分内容来源） - [[译] RESTful API 设计最佳实践](https://juejin.im/entry/59e460c951882542f578f2f0) - [那些年，我们一起误解过的 REST](https://segmentfault.com/a/1190000016313947) - [Testing RESTful Services in Java: Best Practices](https://phauer.com/2016/testing-RESTful-services-java-best-practices/) @@ -138,4 +170,4 @@ GET /classes?page=1&size=10 //指定第1页，每页10个数据 - [Building REST services with Spring](https://spring.io/guides/tutorials/classmarks/) (Spring 官网 ) - [An Intro to Spring HATEOAS](https://www.baeldung.com/spring-hateoas-tutorial) （by [baeldung](https://www.baeldung.com/author/baeldung/)） - [spring-hateoas-examples](https://github.com/spring-projects/spring-hateoas-examples/tree/master/hypermedia) -- [Spring HATEOAS](https://spring.io/projects/spring-hateoas#learn) (Spring 官网 ) +- [Spring HATEOAS](https://spring.io/projects/spring-hateoas#learn) (Spring 官网 ) \ No newline at end of file From 49a3a152eb5851f6afd7596460d37bfebed91882 Mon Sep 17 00:00:00 2001 From: guide Date: Fri, 7 May 2021 16:02:06 +0800 Subject: [PATCH 2/3] =?UTF-8?q?Update=20RESTfulAPI=E7=AE=80=E6=98=8E?= =?UTF-8?q?=E6=95=99=E7=A8=8B.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...00\346\230\216\346\225\231\347\250\213.md" | 55 ++++++++++--------- 1 file changed, 28 insertions(+), 27 deletions(-) diff --git "a/docs/system-design/coding-way/RESTfulAPI\347\256\200\346\230\216\346\225\231\347\250\213.md" "b/docs/system-design/coding-way/RESTfulAPI\347\256\200\346\230\216\346\225\231\347\250\213.md" index 3eb26b993f8..aaeacaa9639 100644 --- "a/docs/system-design/coding-way/RESTfulAPI\347\256\200\346\230\216\346\225\231\347\250\213.md" +++ "b/docs/system-design/coding-way/RESTfulAPI\347\256\200\346\230\216\346\225\231\347\250\213.md" @@ -1,10 +1,10 @@ ![](https://img-blog.csdnimg.cn/2021050713553862.png) -大家好，我是 Guide 哥！ +大家好，我是 Guide哥！ 这篇文章简单聊聊后端程序员必备的 RESTful API 相关的知识。 -开始正式介绍 RESTful API 之前，我们需要首先搞清 ：**API 到底是什么？** +开始正式介绍 RESTful API 之前，我们需要首先搞清 ：**API 到底是什么？** ## 何为 API？ @@ -18,13 +18,13 @@ 但是， API 不仅仅代表后端系统暴露的接口，像框架中提供的方法也属于 API 的范畴。 -为了方便大家理解，我再列举几个例子🌰： +为了方便大家理解，我再列举几个例子 🌰： 1. 你通过某电商网站搜索某某商品，电商网站的前端就调用了后端提供了搜索商品相关的 API。 2. 你使用 JDK 开发 Java 程序，想要读取用户的输入的话，你就需要使用 JDK 提供的 IO 相关的 API。 3. ...... -你可以把 API 理解为程序与程序之间通信的桥梁，其本质就是一个函数而已。另外，API 的使用也不是没有章法的，它的规则由（比如数据输入和输出的格式）API提供方制定。 +你可以把 API 理解为程序与程序之间通信的桥梁，其本质就是一个函数而已。另外，API 的使用也不是没有章法的，它的规则由（比如数据输入和输出的格式）API 提供方制定。 ## 何为 RESTful API？ @@ -61,13 +61,13 @@ POST /classes：新建一个班级 2. 客户端和服务器之间，传递这种资源的某种表现形式比如 `json`，`xml`，`image`,`txt` 等等； 3. 客户端通过特定的 HTTP 动词，对服务器端资源进行操作，实现"表现层状态转化"。 -## REST API 规范 +## RESTful API 规范 ![](https://img-blog.csdnimg.cn/20210507154007779.png) ### 动作 -- `GET `：请求从服务器获取特定资源。举个例子：`GET /classes`（获取所有班级） +- `GET`：请求从服务器获取特定资源。举个例子：`GET /classes`（获取所有班级） - `POST` ：在服务器上创建一个新的资源。举个例子：`POST /classes`（创建班级） - `PUT` ：更新服务器上的资源（客户端提供更新后的整个资源）。举个例子：`PUT /classes/12`（更新编号为 12 的班级） - `DELETE` ：从服务器删除特定的资源。举个例子：`DELETE /classes/12`（删除编号为 12 的班级） @@ -77,13 +77,13 @@ POST /classes：新建一个班级 路径又称"终点"（endpoint），表示 API 的具体网址。实际开发中常见的规范如下： -1. **网址中不能有动词，只能有名词，API 中的名词也应该使用复数。** 因为 REST 中的资源往往和数据库中的表对应，而数据库中的表都是同种记录的"集合"（collection）。**如果 API 调用并不涉及资源（如计算，翻译等操作）的话，可以用动词。** 比如：`GET /calculate?param1=11¶m2=33` -2. 不用大写字母，建议用中杠 - 不用下杠 \_ 比如邀请码写成 `invitation-code`而不是 ~~invitation_code~~ +1. **网址中不能有动词，只能有名词，API 中的名词也应该使用复数。**因为 REST 中的资源往往和数据库中的表对应，而数据库中的表都是同种记录的"集合"（collection）。如果 API 调用并不涉及资源（如计算，翻译等操作）的话，可以用动词。比如：`GET /calculate?param1=11¶m2=33` 。 +2. **不用大写字母，建议用中杠 - 不用下杠 \_** 。比如邀请码写成 `invitation-code`而不是 ~~invitation_code~~ 。 +3. **善用版本化 API**。当我们的 API 发生了重大改变而不兼容前期版本的时候，我们可以通过 URL 来实现版本化，比如 `Http://api.example.com/v1`、`http://apiv1.example.com` 。版本不必非要是数字，只是数字用的最多，日期、季节都可以作为版本标识符，项目团队达成共识就可。 +4. **接口尽量使用名词，避免使用动词。** RESTful API 操作（HTTP Method）的是资源（名词）而不是动作（动词）。 Talk is cheap！来举个实际的例子来说明一下吧！现在有这样一个 API 提供班级（class）的信息，还包括班级中的学生和教师的信息，则它的路径应该设计成下面这样。 -**接口尽量使用名词，禁止使用动词。** 下面是一些例子： - ``` GET /classes：列出所有班级 POST /classes：新建一个班级 @@ -132,14 +132,13 @@ GET /classes?page=1&size=10 //指定第1页，每页10个数据 | | | 404 未找到 | | | | | 405 请求方法不对 | | - ## RESTful 的极致 HATEOAS > **RESTful 的极致是 hateoas ，但是这个基本不会在实际项目中用到。** 上面是 RESTful API 最基本的东西，也是我们平时开发过程中最容易实践到的。实际上，RESTful API 最好做到 Hypermedia，即返回结果中提供链接，连向其他 API 方法，使得用户不查文档，也知道下一步应该做什么。 -比如，当用户向 api.example.com 的根目录发出请求，会得到这样一个文档。 +比如，当用户向 `api.example.com` 的根目录发出请求，会得到这样一个返回结果 ```javascript {"link": { @@ -150,24 +149,26 @@ GET /classes?page=1&size=10 //指定第1页，每页10个数据 }} ``` -上面代码表示，文档中有一个 link 属性，用户读取这个属性就知道下一步该调用什么 API 了。rel 表示这个 API 与当前网址的关系（collection 关系，并给出该 collection 的网址），href 表示 API 的路径，title 表示 API 的标题，type 表示返回类型 Hypermedia API 的设计被称为[HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)。 +上面代码表示，文档中有一个 `link` 属性，用户读取这个属性就知道下一步该调用什么 API 了。`rel` 表示这个 API 与当前网址的关系（collection 关系，并给出该 collection 的网址），`href` 表示 API 的路径，title 表示 API 的标题，`type` 表示返回类型 `Hypermedia API` 的设计被称为[HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)。 -在 Spring 中有一个叫做 HATEOAS 的 API 库，通过它我们可以更轻松的创建除符合 HATEOAS 设计的 API。 +在 Spring 中有一个叫做 HATEOAS 的 API 库，通过它我们可以更轻松的创建除符合 HATEOAS 设计的 API。相关文章： -## 文章推荐 +- [在 Spring Boot 中使用 HATEOAS](a) +- [Building REST services with Spring](https://spring.io/guides/tutorials/classmarks/) (Spring 官网 ) +- [An Intro to Spring HATEOAS](https://www.baeldung.com/spring-hateoas-tutorial) +- [spring-hateoas-examples](https://github.com/spring-projects/spring-hateoas-examples/tree/master/hypermedia) +- [Spring HATEOAS](https://spring.io/projects/spring-hateoas#learn) (Spring 官网 ) -**RESTful API 介绍：** +## 参考 -- [RESTful API Tutorial](https://RESTfulapi.net/) -- [RESTful API 最佳指南](http://www.ruanyifeng.com/blog/2014/05/RESTful_api.html)（阮一峰，这篇文章大部分内容来源） -- [[译] RESTful API 设计最佳实践](https://juejin.im/entry/59e460c951882542f578f2f0) -- [那些年，我们一起误解过的 REST](https://segmentfault.com/a/1190000016313947) -- [Testing RESTful Services in Java: Best Practices](https://phauer.com/2016/testing-RESTful-services-java-best-practices/) +- https://RESTfulapi.net/ -**Spring 中使用 HATEOAS：** +- http://www.ruanyifeng.com/blog/2014/05/RESTful_api.html -- [在 Spring Boot 中使用 HATEOAS](a) -- [Building REST services with Spring](https://spring.io/guides/tutorials/classmarks/) (Spring 官网 ) -- [An Intro to Spring HATEOAS](https://www.baeldung.com/spring-hateoas-tutorial) （by [baeldung](https://www.baeldung.com/author/baeldung/)） -- [spring-hateoas-examples](https://github.com/spring-projects/spring-hateoas-examples/tree/master/hypermedia) -- [Spring HATEOAS](https://spring.io/projects/spring-hateoas#learn) (Spring 官网 ) \ No newline at end of file +- https://juejin.im/entry/59e460c951882542f578f2f0 + +- https://phauer.com/2016/testing-RESTful-services-java-best-practices/ + +- https://www.seobility.net/en/wiki/REST_API + +- https://dev.to/duomly/rest-api-vs-graphql-comparison-3j6g \ No newline at end of file From 683ad17898641368de888f0d96dc25e45059faa0 Mon Sep 17 00:00:00 2001 From: guide Date: Fri, 7 May 2021 16:21:13 +0800 Subject: [PATCH 3/3] =?UTF-8?q?[feat]=20=E7=B3=BB=E7=BB=9F=E8=AE=BE?= =?UTF-8?q?=E8=AE=A1=E5=BF=85=E5=A4=87=E5=9F=BA=E7=A1=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 16 +++++++--- ...26\347\250\213\350\247\204\350\214\203.md" | 30 ------------------- 2 files changed, 12 insertions(+), 34 deletions(-) delete mode 100644 "docs/java/Java\347\274\226\347\250\213\350\247\204\350\214\203.md" diff --git a/README.md b/README.md index f968d9713d6..4c13017e853 100644 --- a/README.md +++ b/README.md @@ -153,11 +153,19 @@ ## 系统设计 -### 编码之道(必看 :+1:) +### 系统设计必备基础 -1. [RestFul API 简明教程](docs/system-design/coding-way/RESTfulAPI简明教程.md) -2. [Java 编程规范以及优雅 Java 代码实践总结](docs/java/Java编程规范.md) -3. [Java 命名之道](docs/system-design/naming.md) +#### RESTful API + +我们在进行后端开发的时候，主要的工作就是为前端或者其他后端服务提供 API 比如查询用户数据的 API 。RESTful API 是一种基于 REST 构建的 API，它是一种被设计的更好使用的 API。 + +相关阅读：[RestFul API 简明教程](docs/system-design/coding-way/RESTfulAPI简明教程.md) + +#### 命名 + +编程过程中，一定要重视命名。因为好的命名即是注释，别人一看到你的命名就知道你的变量、方法或者类是做什么的！ + +相关阅读： [Java 命名之道](docs/system-design/naming.md) 。 ### 常用框架 diff --git "a/docs/java/Java\347\274\226\347\250\213\350\247\204\350\214\203.md" "b/docs/java/Java\347\274\226\347\250\213\350\247\204\350\214\203.md" deleted file mode 100644 index 6b4731ef3c9..00000000000 --- "a/docs/java/Java\347\274\226\347\250\213\350\247\204\350\214\203.md" +++ /dev/null @@ -1,30 +0,0 @@ -讲真的，下面推荐的文章或者资源建议阅读 3 遍以上。 - -### 团队 - -- **阿里巴巴Java开发手册（详尽版）** -- **Google Java编程风格指南：** - -### 个人 - -- **程序员你为什么这么累:** - -### 如何写出优雅的 Java 代码 - -1. 使用 IntelliJ IDEA 作为您的集成开发环境 (IDE) -1. 使用 JDK 8 或更高版本 -1. 使用 Maven/Gradle -1. 使用 Lombok -1. 编写单元测试 -1. 重构:常见,但也很慢 -1. 注意代码规范 -1. 定期联络客户，以获取他们的反馈 - -上述建议的详细内容：[八点建议助您写出优雅的Java代码](https://mp.weixin.qq.com/s?__biz=Mzg2OTA0Njk0OA==&mid=2247485140&idx=1&sn=ecaeace613474f1859aaeed0282ae680&chksm=cea2491ff9d5c00982ffaece847ce1aead89fdb3fe190752d9837c075c79fc95db5940992c56&token=1328169465&lang=zh_CN&scene=21#wechat_redirect)。 - -更多代码优化相关内容推荐： - -- [业务复杂=if else？刚来的大神竟然用策略+工厂彻底干掉了他们！](https://juejin.im/post/5dad23685188251d2c4ea2b6) -- [一些不错的 Java 实践！推荐阅读3遍以上！](http://lrwinx.github.io/2017/03/04/%E7%BB%86%E6%80%9D%E6%9E%81%E6%81%90-%E4%BD%A0%E7%9C%9F%E7%9A%84%E4%BC%9A%E5%86%99java%E5%90%97/) -- [[解锁新姿势] 兄dei，你代码需要优化了](https://juejin.im/post/5dafbc02e51d4524a0060bdd) -- [消灭 Java 代码的“坏味道”](https://mp.weixin.qq.com/s?__biz=Mzg2OTA0Njk0OA==&mid=2247485599&idx=1&sn=d83ff4e6b1ee951a0a33508a10980ea3&chksm=cea24754f9d5ce426d18b435a8c373ddc580c06c7d6a45cc51377361729c31c7301f1bbc3b78&token=1328169465&lang=zh_CN#rd) \ No newline at end of file