| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697 |
- = 软件优雅设计与开发最佳实践 =
- =====
- :Shoulder: Specifications
- :Author: lym
- :Email: <cn_lym@foxmail.com>
- :Date: 2020
- :Revision: 1.0
- :doctype: book
- :revdate: {docdate}
- :sectanchors:
- :xrefstyle: full
- :anchor:
- :toc: left
- :toclevels: 3
- :sectnumlevels: 5
- == 简介
- 分享软件系统设计、开发中一些利于项目维护、安全和快速落地的 *最佳实践准则* 。
- [TIP]
- ====
- 这些规范中给出了良好的实践方案，但不要为了规范而规范，盲目地做太多苛刻格式限制而偏离了规范意义的本质。
- 规范本是为了更好的解决问题而定义的，在不同场景下的最佳实践方案可能会有变化，要根据实际情况指定规范。
- ====
- 规范部分不针对特定语言，但为了帮助规范更容易地落地，推荐开发脚手架，便于快速开发， <<shoulder-framework, 这里实现了Java 的框架 shoulder-framework>> 。
- [TIP]
- ====
- - **Shoulder** 并未与该规范完全绑定，而是实现功能性的接口，以扩展形式作为默认实现。
- - **Shoulder** 允许使用者二次开发，制定自己团队的规范，通过简单地对 **Shoulder** 扩展即可实现自己的规范与丰富的功能。
- ====
- === 开发
- ==== link:specs/base/basic.html[基本]
- ==== link:specs/base/log.html[日志]
- ==== link:specs/base/errorCode.html[错误码]
- ==== link:specs/base/api.html[接口开发]
- ==== link:specs/base/cache.html[缓存]
- ==== link:specs/base/communication.html[服务通信]
- ==== link:specs/base/notify.html[消息通知]
- ==== link:specs/base/i18n.html[国际化]
- === 安全
- ==== link:specs/security/security.html[数据保护与安全原则]
- ==== link:specs/security/crypto.html[加密方案与应用]
- ==== link:specs/security/auth.html[认证授权]
- ==== link:specs/security/negotiate.html[密钥协商]
- === 发布、部署、升级
- ==== link:specs/devOps/cicd.html[持续集成]
- ==== link:specs/devOps/cloud-artifact.html[系统架构]
- ==== link:specs/devOps/monitor.html[状态监控与告警]
- ==== link:specs/devOps/deployAndUpgrade.html[部署与升级]
- === 管理
- ==== link:specs/manager/directory.html[发布软件目录结构]
- ==== link:specs/manager/package.html[Java 工程目录结构推荐]
- === 常用技术
- ==== link:specs/technology/java.html[Java 编码规范]
- ==== link:specs/technology/javaScript.html[JavaScript 编码规范]
- ==== link:specs/technology/python.html[Python 编码规范]
- ==== link:specs/technology/go.html[Go 编码规范]
- ==== link:specs/technology/db.html[数据库 实践手册]
- ==== link:specs/technology/es.html[ElasticSearch 实践手册]
- == 网站运营
- ==== link:seo/seo.html[SEO]
- == IDEA
- ==== link:blog/idea/plugins.html[IDEA-Plugins]
- == 实践与落地（开源框架）
- 规范定义了一些要求，应用实践起来必然存在大量重复代码，为了将这些规范优雅快速落地，提升开发效率，特编写可复用的软件开发框架来实现，*同样开源！*。
- === shoulder-framework
- ==== *link:https://gitee.com/ChinaLym/shoulder-framework[gitee]*
- ==== *link:https://gitee.com/ChinaLym/shoulder-framework[github]*
- 欢迎补充完善。
- == 附录
- ==== link:ref/technologies.html[技术名词解析]
- ==== link:ref/port.html[IANA 持有端口列表]
- ==== link:ref/aes.html[AES介绍]
|
