程序规范建议-运维写给开发

                程序规范建议

为了是方便管理，易于排错希望大家履行以下规范

一.sql脚本规范
1.所有的updata需要有select备份。
2.修改数据需要带上‘limit’，并基本上不予许模糊条件
3.所有上生产的sql至少需要经过三人，写、审核、执行不能同一人作为2项或三项
4.所有的sql语句带上库名（防止执行错库）
5.尽量做到可重复执行,注明：是否可以重复执行
6.审核人评估sql执行时间影响范围

二.部署文档规范
1.部署文档变量不能截图，需写清楚然后运维采用复制粘贴
2.部署文档按部署因有发版顺序说明（依赖模块，或者无依赖需说明清楚）
3.文档说明要求清晰。（运维文档要求：非技术人员/非本项目人员按照文档能成功上线）
4.非本次部署的配置及时清理，防止被重新部署（部署不固定人，多余配置存在安全隐患）
5.部署文档需要有版本说明。（修复/变更内容）

三.接口规范：
1.接口地址：各项目采用 ‘地址+/项目英文/’：比如 xxx.xxxx.com/xxxx/ (目前交易结算的接口没有区分导致nginx规则配置复杂冗余)
2.接口地址需要区分项目，还要区分内外网（在接口地址中体现，在对外的nginx规则中直接屏蔽内部接口访问）
3.交易结算老接口改造，新接口按规范
4.接口安全校验，防刷设置

四.用户真实ip获取规则：
1.无论前端还是后台获取真实ip一律使用X-Forwarded-Fo变量（还要对改变了进行分析，多个ip以' ,' 号分割取第一个值）
2.该变量的值格式可能为 X-Forwarded-For = '111.11.111.111' 也可能X-Forwarded-For ='111.11.111.111,122.22.222.22,133.333.33.333'
3.前端获取真实ip后应该将该ip以X-Forwarded-For变量往后台传递

五.有内网外地址的配置规范
内网还是外网地址
1.对于有外网域名地址的服务
设置变量时要配置2个参数，写清楚备注:一个是内部使用，一个外部使用。
2.请求时要区分内网-外网调用
内部服务调用：60020端口走http，且配置hosts别名
外部访问调用：走443或者80端口 建议走https,使用公网域名

六.开发代码日志规范要求：
1.日志配置文件提取出war包，运维可配置。
1.日志打印中不能把账号密码打印出来
2.日志打印接口参数敏感信息要脱敏
3.用户敏感信息：银行卡×××不予许打印日志中
4.日志要实用利于排查问题
5.日志文件分割大小设置为2G（读取还算正常，避免文件过多导致运维不好监控，不好日后归档维护）

七.代码支持sni或者忽略hostname校验，与第三方对接时需要提醒对方。
https://help.aliyun.com/knowledge_detail/40519.html?spm=5176.11065259.1996646101.searchclickresult.772866cfs007Zw

八.高可用
1.所有模块需要做到会话共享。
2.支持高可用，集群/主备/独立工作