开发说明.md · ymgwjk/handwriting-backend

# 后端开发说明

## Java端

Java端采用Springboot进行开发，建议开发前找一些快速上手的教程学习一下。

### 软件包说明

- config：存放配置，一般情况下不需要动
- controller：控制器，定义与客户端通信的接口
- entity：实体类，一般用来映射数据库表
- mapper：数据库操作类，一般一个实体类对应一个Mapper。
- service：服务类，存放核心逻辑。
- utils：工具类

其他软件包根据需要自行添加

### 一些规范

- 上述包中config、controller、mapper包里的类命名都使用xxx+包名的形式。如：UserMapper，ModelController，OpenApiConfig
- controller的类名前加@RestController，里面不要定义非接口函数，非接口工具函数请在service中或utils中定义。接口函数要加xxxMapping注解，根据协议更改xxx的内容，如GetMapping，PostMapping。关于它们的用法建议多进行百度。
- controller中，如果需要接收客户端的文件，请在Mapping注解中添加consumes="multipart/form-data"，并在函数的文件参数（MultipartFile类型）前添加@RequestPart("参数名")。

- 实体类的mapper命名为：实体类名+Mapper，如User的Mapper命名为UserMapper。
- mapper包里边只定义接口，接口前加@Mapper注解。如果要使用Mybatis Plus，请扩展BaseMapper接口。BaseMapper为泛型接口，要提供该Mapper对应的实体类型。
- 实体类名称尽量与对应的表名相同（即：表名的大驼峰形式）。如果做不到，请在实体类前加上@TableName。同样，属性应为字段名的小驼峰形式，否则请在字段前加上@TableField。可以用@TableId注解标记主键。
- 实体类的属性尽量设置为private。尽量用@Data注解，不要自己定义成员函数，除非特殊情况。（@Data注解可以自动向类中添加getter和setter以及toString函数）。

- config包中的类要加@Configuration注解，里面定义的配置函数要加@Bean注解。这个包里的类一般不用动，它用来配置环境，不要用来写业务逻辑。

- 尽可能少用或不用全局变量

## Python端

- 目前的设想是Python端与Java端通过另一个接口进行通信，因此需要用到Flask。Flask的结构和生态比Springboot简单，而且在本项目中要求不高，简单看一下即可。

- Python端要完成的是模型训练和测试。其中为了实现人工设置参数以及前端查看进度，需要让模型尽可能地可配置化，同时在训练过程中保存一个完整的进度数据（比如把loss和accuracy存到队列里）。

- 配置信息最好包括模型文件和数据集文件。为了防止报错，要有一个统一数据集的操作。这个操作视实际格式要求来决定放在Java端还是Python端。（比如要保存成npz的话那肯定是放在python端）

- 每次写完代码更新一下requirements.txt，这样可以保证大家的库版本一样

- 建议使用虚拟环境（如venv、conda等）进行环境配置。

ymgwjk/handwriting-backend

简介

发行版

贡献者

近期动态

ymgwjk/handwriting-backend .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

ymgwjk/handwriting-backend