请参照 platform-biz-sample-module-notes 模块的代码阅读本文档。本框架中,一个模块的分为三层,实体层(Domain和Mapper)、业务逻辑层(Manager)和 控制器层(Controller),以下为各层的开发规范。
Domain
Domain实体层的基类为 com.supwisdom.platform.biz.core.framework.domain.ABean ,所有实体都必须继承该类。
MyBatis Mapper
本框架中ORM使用MyBatis。一般来说,一个实体对应一个Mapper配置文件,该配置文件放在 src/main/resources中的与对应实体相同的包名下,以 实体名+BaseMapper.xml 命名。XML中Mapper的namespace为对应实体的类名(包括包名)。
接口
接口的一般以 I+实体名+Manager 命名,需继承 com.supwisdom.platform.biz.core.framework.manager.IBaseManager 这个基础接口并可自定义方法。
基类
Manager业务逻辑层的基类为 com.supwisdom.platform.biz.core.framework.manager.ABaseManager,该类实现了实体的一些基本的增删查改等方法(IBaseManager中定义的方法)。一般来说,一个Manager需要实现上面定义的接口并继承ABaseManager。
基类
Controller控制器层的基类为 com.supwisdom.platform.biz.core.framework.controller.ABaseRestController,该类提供了一些基础的增删查改、列表、批量处理等API。
异常处理
捕获Controller中的异常并向外抛出 com.supwisdom.platform.biz.core.framework.exception.RestException。
REST API 设计规范
略
前端API调用请参考 platform-biz-sample-web-notes 中的Notes示例。