没有合适的资源?快使用搜索试试~ 我知道了~
资源推荐
资源详情
资源评论
xx.com
xx.com
1
Java 开发规范
xx 公司
目录
一、 技术栈规约...........................................................................................................................................................................2
二、 编程规约...............................................................................................................................................................................3
(一) 命名风格 ........................................................................................................................................................................3
(二) 常量定义 ........................................................................................................................................................................6
(三) 注释规约 ........................................................................................................................................................................6
(四) 逻辑规约 ........................................................................................................................................................................8
(五) 前后端规约 ..................................................................................................................................................................10
(六) 测试规约 ......................................................................................................................................................................11
三、 安全规约.............................................................................................................................................................................12
(一) 数据安全 ......................................................................................................................................................................12
(二) Web 安全 .....................................................................................................................................................................12
四、 数据库规约.........................................................................................................................................................................12
(一) 库表规约 ......................................................................................................................................................................13
(二) 索引规约 ......................................................................................................................................................................14
五、 Git 规约 ..............................................................................................................................................................................14
xx.com
xx.com
2
(一) 开发分支 ......................................................................................................................................................................14
(二) 发布测试 ......................................................................................................................................................................15
(三) 发布生产 ......................................................................................................................................................................15
(四) 提交推送 ......................................................................................................................................................................15
版本
更新时间
修改人
一、技术栈规约
应用场景
技术栈
版本
备注
Java SDK
JDK
8
IDE
IntelliJ IDEA
构建工具
Apache Maven
3.x
核心框架
Spring + Spring Boot + Spring Cloud + Spring
Cloud Alibaba
注册中心+配置中
心
Alibaba Nacos
2.2.1
服务网关
Spring Cloud Gateway
2.2.0
分布式事务
Alibaba Seata
2.2.1
高可用流量管理框
架(断路器)
Alibaba Sentinel
2.2.1
服务调用
Spring Cloud Openfeign
2.2.3
应用服务器
Apache Tomcat
9.0.39
视图框架
Spring MVC
5.2.10
服务监控
Spring Boot Admin
持久框架
Apache Mybatis(mybatis-spring-boot-starter)
2.1.1
支付框架
使用公共组件 pay-xx-starter
文件上传
使用公共组件(特殊需求除外)
数据库
MySQL
8
MySQL 数 据 库 连
接池
HikariCP
3.4.5
使用公共组件 datasource-xx-starter
MongoDB
MongoDB(spring.data.mongodb)
3.0.x
使用公共组件 mongodb-xx-starter
xx.com
xx.com
3
缓存
Apache Redis(spring-data-redis)
2.3.x
使用公共组件 redis-xx-starter
分布式锁
Redisson
3.15.0
使用公共组件 redisson-xx-starter
消息队列
RabbitMQ(spring-rabbit)
2.2.9
使用公共组件 mq-xx-starter
搜索引擎
Elastic Search
7.3.0
负载均衡、静态服
务器
Apache Nginx
安全框架(登录、
权限、认证)
Spring Security + OAuthor2 + JWT Token
定时任务
Spring Scheduler
日志处理
Logback
4.1.1.0
JSON 处理
Alibaba Fastjson
1.2.71
模板引擎(PC前端)
Vue
移动端(h5、小程
序)
uniApp
商家后台页面(PC)
React
平台管理后台页面
(PC)
React
React UI 组件
Alibaba Ant Design
二、编程规约
(一) 命名风格
1. 包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式,但是
类名如果有复数含义,类名可以使用复数形式。命名区分度要高,减少与现有模块的命名冲突。包名、
groupId 统一使用前缀 com.xxx(xxx 替换为公司简写) ,若不是请确认。
正例:package com.jd.bbc.core.util / public class XmlUtils
2. 代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束,名称不能使用
JAVA 中的关键字。
反例:_name / __name / $name / name_ / name$ / name__ / double
3. 命名使用英文词组合,严禁使用中文拼音或拼音首字母组合命名(专有名词例外)。
4. 类名使用 UpperCamelCase 风格,但以下情形例外:DO / BO / DTO / VO / AO / PO / UID 等。
剩余14页未读,继续阅读
资源评论
人在江湖
- 粉丝: 3
- 资源: 5
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功