背景
都说翻阅官方文档是非常重要的,但翻阅国外的官方文档是间很头痛的事情,因为文档太多太乱根本不知道如何翻起,很多时候我们都需要别人帮我们找到对应的文档,然后我们再慢慢阅读。今天我讲解下Spring官方文档的结构,理解了之后可以随意找到自己想看到的文档。
会者不难,难得不会,希望能帮到一些朋友
进入文档
我一般喜欢百度“spring官网”,也可以直接输入地址
https://spring.io/
首页和其他页面都是spring的花边意义不大,我们通常关注如何使用spring,基本上都在Projects里
https://spring.io/projects
浏览Projects
Spring是个全家桶,里面包含了各种项目分别用于开发的不同场景,这些项目都可以通过引入maven或者starter实现和spring整合,找到你关心的project是第一位
对于我来说,我的目的是学习spring框架本身,所以我的研究顺序就是下面三个
- springframework
- springBoot
- springcloud
后面我也会关注 - spring data
- spring security
项目文档归类
找到项目后如何查阅该项目的所有官方文档呢,基本上有下面几类
overview页面仅仅是介绍,可以不看
点击learn页面(重点)
选择版本
选择一个稳定的版本或者和自己项目一致的版本,不同的版本文档可能存在不小的差异,一定要和自己看的代码一致。
Reference Doc(官方文档)
参考文档即我们通常意义的参考文档,对我来说是我最想看到的
API Doc
spring的接口文档,涉及开发时才会翻阅(感觉不如直接看代码)
总结
个人觉得最有用的就是Reference Doc部分,如果可以详细阅读spring相关的文档并加以理解,对于spring框架的认识会有本质不同