《阿里巴巴Java开发手册》5之安全规约

安全规约

  1. 【强制】隶属于用户个人的页面或者功能必须进行权限控制校验。
    说明:防止没有做水平权限校验就可随意访问、操作别人的数据,比如查看、修改别人的订单。

  2. 【强制】用户敏感数据禁止直接展示,必须对展示数据脱敏。
    说明:查看个人手机号码会显示成:158**9119,隐藏中间 4 位,防止隐私泄露。

  3. 【强制】用户输入的 SQL 参数严格使用参数绑定或者 METADATA 字段值限定,防止 SQL 注入,
    禁止字符串拼接 SQL 访问数据库。

  4. 【强制】用户请求传入的任何参数必须做有效性验证。
    说明:忽略参数校验可能导致:

    • page size 过大导致内存溢出
    • 恶意 order by 导致数据库慢查询
    • 任意重定向
    • SQL 注入
    • 反序列化注入
    • 正则输入源串拒绝服务 ReDoS

    说明:Java 代码用正则来验证客户端的输入,有些正则写法验证普通用户输入没有问题,
    但是如果攻击人员使用的是特殊构造的字符串来验证,有可能导致死循环的效果。



《阿里巴巴Java开发手册》4-3之服务器规约

工程规约 - 服务器规约

  1. 【推荐】高并发服务器建议调小 TCP 协议的 time wait 超时时间。
    说明:操作系统默认 240 秒后,才会关闭处于 time
    wait 状态的连接,在高并发访问下,服
    务器端会因为处于 time _ wait 的连接数太多,可能无法建立新的连接,所以需要在服务器上
    调小此等待值。
    正例:在 linux 服务器上请通过变更/ etc / sysctl . conf 文件去修改该缺省值 ( 秒 ) :

    1
    net . ipv 4. tcp _ fin _ timeout = 30
  2. 【推荐】调大服务器所支持的最大文件句柄数 (File Descriptor ,简写为 fd) 。
    说明:主流操作系统的设计是将 TCP / UDP 连接采用与文件一样的方式去管理,即一个连接对
    应于一个 fd 。主流的 linux 服务器默认所支持最大 fd 数量为 1024,当并发连接数很大时很
    容易因为 fd 不足而出现“ open too many files ”错误,导致新的连接无法建立。 建议将 linux
    服务器所支持的最大句柄数调高数倍 ( 与服务器的内存数量相关 ) 。

  3. 【推荐】给 JVM 设置- XX :+ HeapDumpOnOutOfMemoryError 参数,让 JVM 碰到 OOM 场景时输出
    dump 信息。
    说明: OOM 的发生是有概率的,甚至有规律地相隔数月才出现一例,出现时的现场信息对查错
    非常有价值。

  4. 【参考】服务器内部重定向使用 forward; 外部重定向地址使用 URL 拼装工具类来生成,否则
    会带来 URL 维护不一致的问题和潜在的安全风险。

以上内容均整理自《阿里巴巴Java开发手册》

下载

提供Gitbook在线阅读和pdf下载:查看福利



《阿里巴巴Java开发手册》4-2之二方库规约

工程规约 - 二方库规约

  1. 【强制】定义 GAV 遵从以下规则:
    1 ) G GroupID 格式: com .{公司/ BU }.业务线. [ 子业务线 ] ,最多 4 级。
    说明:{公司/ BU } 例如: alibaba / taobao / tmall / aliexpress 等 BU 一级 ; 子业务线可选。
    正例: com . taobao . jstorm 或 com.alibaba.dubbo.register
    2 ) A ArtifactID 格式:产品线名-模块名。语义不重复不遗漏,先到仓库中心去查证一下。
    正例: dubbo - client / fastjson - api / jstorm - tool
    3 ) V Version :详细规定参考下方。
  2. 【强制】二方库版本号命名方式:主版本号.次版本号.修订号
    1 ) 主版本号 主版本号:当做了不兼容的 API 修改,或者增加了能改变产品方向的新功能。
    2 ) 次版本号 次版本号:当做了向下兼容的功能性新增 ( 新增类、接口等 ) 。
    3 ) 修订号 修订号:修复 bug ,没有修改方法签名的功能加强,保持 API 兼容性。
    说明:起始版本号必须为: 1.0.0 ,而不是 0.0.1
  3. 【强制】线上应用不要依赖 SNAPSHOT 版本 ( 安全包除外 ); 正式发布的类库必须使用 RELEASE
    版本号升级+1 的方式,且版本号不允许覆盖升级,必须去中央仓库进行查证。
    说明:不依赖 SNAPSHOT 版本是保证应用发布的幂等性。另外,也可以加快编译时的打包构建。


《阿里巴巴Java开发手册》4-1之应用分层

工程规约 - 应用分层

  1. 【推荐】图中默认上层依赖于下层,箭头关系表示可直接依赖,如:开放接口层可以依赖于
    Web 层,也可以直接依赖于 Service 层,依此类推:

    • 开放接口层:可直接封装 Service 接口暴露成 RPC 接口 ; 通过 Web 封装成 http 接口 ; 网关控

    制层等。

    • 终端显示层:各个端的模板渲染并执行显示层。当前主要是 velocity 渲染, JS 渲染, JSP 渲

    染,移动端展示层等。

    • Web 层 层:主要是对访问控制进行转发,各类基本参数校验,或者不复用的业务简单处理等。

    • Service 层 层:相对具体的业务逻辑服务层。

    • Manager 层 层:通用业务处理层,它有如下特征:

      1) 对第三方平台封装的层,预处理返回结果及转化异常信息 ;

      2)对 Service 层通用能力的下沉,如缓存方案、中间件通用处理 ;

      3)与 DAO 层交互,对 DAO 的业务通用能力的封装。

    • DAO 层:数据访问层,与底层 MySQL 、 Oracle 、 Hbase 进行数据交互。

    • 外部接口或第三方平台:包括其它部门 RPC 开放接口,基础平台,其它公司的 HTTP 接口。

  2. 【参考】 ( 分层异常处理规约 ) 在 DAO 层,产生的异常类型有很多,无法用细粒度异常进行
    catch ,使用 catch(Exception e) 方式,并 throw new DAOException(e) ,不需要打印日志,
    因为日志在 Manager / Service 层一定需要捕获并打到日志文件中去,如果同台服务器再打日
    志,浪费性能和存储。在 Service 层出现异常时,必须记录日志信息到磁盘,尽可能带上参数
    信息,相当于保护案发现场。如果 Manager 层与 Service 同机部署,日志方式与 DAO 层处理
    一致,如果是单独部署,则采用与 Service 一致的处理方式。 Web 层绝不应该继续往上抛异常,
    因为已经处于顶层,无继续处理异常的方式,如果意识到这个异常将导致页面无法正常渲染,
    那么就应该直接跳转到友好错误页面,尽量加上友好的错误提示信息。开放接口层要将异常处
    理成错误码和错误信息方式返回。

  3. 【参考】分层领域模型规约:

    • DO(Data Object) :与数据库表结构一一对应,通过 DAO 层向上传输数据源对象。
    • DTO(Data Transfer Object) :数据传输对象, Service 和 Manager 向外传输的对象。
    • BO(Business Object) :业务对象。可以由 Service 层输出的封装业务逻辑的对象。
    • QUERY :数据查询对象,各层接收上层的查询请求。注:超过 2 个参数的查询封装,禁止
      使用 Map 类来传输。
    • VO(View Object) :显示层对象,通常是 Web 向模板渲染引擎层传输的对象。

以上内容均整理自《阿里巴巴Java开发手册》

下载

提供Gitbook在线阅读和pdf下载:查看福利



《阿里巴巴Java开发手册》3-4之ORM规约

ORM 规约

  1. 【强制】在表查询中,一律不要使用 * 作为查询的字段列表,需要哪些字段必须明确写明。
    说明:1 ) 增加查询分析器解析成本。2 ) 增减字段容易与 resultMap 配置不一致。

  2. 【强制】 POJO 类的 boolean 属性不能加 is ,而数据库字段必须加 is _,要求在 resultMap 中
    进行字段与属性之间的映射。
    说明:参见定义 POJO 类以及数据库字段定义规定,在 sql . xml 增加映射,是必须的。

  3. 【强制】不要用 resultClass 当返回参数,即使所有类属性名与数据库字段一一对应,也需
    要定义 ; 反过来,每一个表也必然有一个与之对应。
    说明:配置映射关系,使字段与 DO 类解耦,方便维护。

  4. 【强制】 xml 配置中参数注意使用:#{},# param # 不要使用${} 此种方式容易出现 SQL 注
    入。



本站访问量   |   您是第 位.