dev-doc.md · MagiCodeX/molihua-webapp-scaffold

# 开发文档

## 前端开发

### 配置页面

* 启动应用时会扫描 ".conf.json" 后缀的配置文件并注册页面，配置示例如下:

```
[
  ...
  {
    // 请求URL
    "urlPattern": "/app/example1",
    // 页面代码
    "pageCode": "example1",
    // 页面标题
    "pageName": "示例1",
    // 文件路径
    "filePath": "example/example1.html"
  }
  ...
]
```

### 实现多语言

* 启动应用时会扫描 ".i18n.properties" 后缀的文件并注册多语言，代码中使用示例如下:

```
<table>
<thead>
  <tr>
    <th>${t('ui.example.example2.field.id')}</th>
    <th>${t('ui.example.example2.field.name')}</th>
    <th>${t('ui.example.example2.field.remark')}</th>
  </tr>
</thead>
</table>
```

备注：前端多语言命名格式是: ui.模块.功能.类别.描述

### 配置静态资源映射

* 启动应用时默认读取 "config/urlMappingRules.json" 配置并生成 URL 映射关系，配置示例如下:

```
[
  ...
  {
    // 来源 URL 前缀
    "originalUrlPrefix": "/static/lib/jquery/",
    // 映射 URL 前缀
    "mappedUrlPrefix": "/static/lib/jquery3_3_1/",
    // 资源路径
    "resourceBasePath": "classpath:/public/static/lib/jquery/",
    // 是否优先映射 min.xx 后缀
    "minSuffixPriority": true
  }
  ...
]
```

### 使用 JSX 生成页面

* 可以使用命令 "npm run buildHtml" 批量渲染 JSX 文件成 HTML 内容。
* 可以调用脚本 "build/scripts/jsx-to-html.js" 渲染指定的 JSX 文件成 HTML 内容。

### 单元测试

* 参考 src/main/resources/web-front/test/test-cases/app/example

## 后端开发

### 定义 WEB 请求

* 实用角度考虑，默认使用 POST 请求方式。(需要利用 GET 请求缓存或对外提供 OpenAPI 才遵循 Restful 规范)
* controller 类上加的 RestController 注解不设置 URL 前缀。
* web 层接收参数和返回结果的 DTO 必须是 Web 开头和 DTO 结尾。

## 定义 service 接口

* 定义 service 接口提供给其它模块调用。
* service 接口考虑采用 IXxxxService 命名风格。

### 实现多语言

```
// 定义多语言常量
public interface XxxxMsgConstants {
  @DeclareI18N("你好，世界！")
  String HELLO_WORLD = "server.demo.common.msg.helloWorld";
}

// 获取多语言信息
String message = I18nUtil.getMessage(XxxxMsgConstants.HELLO_WORLD);
```

备注：后端多语言命名格式是: server.模块.功能.类别.描述

### POJO 类型转换

* 映射逻辑写在 XxxxConvertUtil 方法里，同时方法上加上注解 ConvertFrom 和 ConvertTo 标记来源类型和目标类型。
* XxxxConvertUtil 方法里可以调用 MapperUtil 工具类做 POJO 类的字段映射。

### 错误处理

* 使用契约式编程思想，比如使用 CheckUtil 工具类校验参数。
* jasmine.framework.common.exception 包预置相关异常类。

### 单元测试

* 参考 src/test/java/app/modules/example/business/service

### 注意事项

* CsrfTokenUtil 当前实现仅支持单机系统，需要引入 Spring Session 类似单点登录方案后才能支持微服务/分布式系统。

MagiCodeX/molihua-webapp-scaffold

简介

发行版 (4)

贡献者

近期动态

MagiCodeX/molihua-webapp-scaffold .gitee-modal { width: 500px !important; }

简介

发行版 (4)

贡献者

近期动态

搜索帮助

MagiCodeX/molihua-webapp-scaffold