Skip to content

开发手册

Jump to bottom
zhōuhào edited this page Dec 15, 2017 · 16 revisions

hsweb 开发手册

约定

  1. 后台api都使用restful方式,除了GET和DELETE请求以及部分特殊接口,请求头contentType均为application/json. 响应结果统一使用ResponseMessage进行包装,其中的status字段通常与http响应码相同.

ResponseMessage格式示例,成功:

{
"status":200,
"result":{"name":"张三"},
"timestamp": 1513305005178
}

失败:

{
"status":400,
"message":"姓名不能为空",
"result":[{"field":"name","message":"姓名不能为空"}],
"timestamp": 1513305005178
}
  1. 常见http响应码:
    • 200 请求成功
    • 201 成功添加了一条数据
    • 401 未授权.没有登录或者登录超时
    • 403 权限不足、拒绝访问. 请求了没有权限的接口
    • 400 请求参数错误.请确定请求参数正确,可根据响应的数据判断参数错误原因
    • 404 资源不存在.请确定url是否写正确
    • 415 不支持的媒体类型.可能是请求的contentType错误,如:后台需要json,但是传入了form-data
    • 500 服务器异常.应检查服务器日志,或者根据message判断错误原因
  2. 常用异常:
    • BusinessException 在处理业务错误时抛出,对应http响应码:500
    • NotFoundException 资源不存在时抛出,对应http响应码:404
    • UnAuthorizedException 未授权时抛出,对应http响应码:401
    • AccessDenyException 拒绝访问时抛出,对应http响应码:403
    • ValidationException 在验证请求数据格式失败时抛出,对应http响应码:400

框架基础设施

主要为框架提供的常用工具

  1. 增删改查

  2. 权限控制

  3. OAuth2.0

  4. 访问日志

  5. 动态数据源

  6. 常用并发工具

    • 锁,分布式锁
    • 计数器
    • 异步任务,批量任务,事务

  7. 消息封装

    • 消息队列
    • websocket

  8. 其他工具

    • 智能日期格式化
    • excel,word操作
    • 动态脚本引擎

系统功能

主要为框架实现的常用功能

  1. 权限配置
  2. 组织架构
    • 组织架构数据权限控制
    • 人员关系
  3. 数据字典
  4. 动态表单
    • 设计表单
    • 增删改查
    • 验证器
    • 触发器
  5. 文件上传下载
    • 本地文件上传下载
    • 文件秒传
    • 静态文件上传下载
    • 拓展其他文件上传
  6. 定时调度
    • 动态脚本编写定时调度任务
    • 集群下指定固定节点执行任务
  7. 动态脚本
  8. 工作流引擎
    • flowable工作流设计器

website ,donate ,

hsweb 3.0

 3.0,全新的架构
 模块化,更细,更轻
 吸取经验,优化功能

开发手册

  1. 增删改查
  2. 权限控制
  3. 访问日志
  4. 动态数据源
  5. 常用并发工具
  6. 消息封装
  7. 其他工具
Clone this wiki locally