Controller规范和接口定义，添加一条新数据并返回此数据的ID(主键)

本文链接：https://blog.youkuaiyun.com/qq_24271463/article/details/86423175

本文详细阐述了在软件开发中，如何规范地设计Controller层及其接口，包括数据返回格式、参数处理、日志记录等方面的最佳实践，强调统一的ResultBean格式和避免使用map、json等对象传递业务数据。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

<insert id="" parameterType="" useGeneratedKeys="true" keyProperty="id" keyColumn="id">

useGeneratedKeys：必须设置为true，否则无法获取到主键id。 
keyProperty：设置为POJO对象的主键id属性名称。 
keyColumn：设置为数据库记录的主键id字段名称。

1.所有函数返回统一的ResultBean/PageResultBean格式

原因见我的接口定义这个贴。没有统一格式，AOP无法玩。

2.ResultBean/PageResultBean是controller专用的，不允许往后传！

3.Controller做参数格式的转换，不允许把json，map这类对象传到services去，也不允许services返回json、map。

一般情况下！写过代码都知道，map，json这种格式灵活，但是可读性差，如果放业务数据，每次阅读起来都比较困难。定义一个bean看着工作量多了，但代码清晰多了。

4.参数中一般情况不允许出现Request，Response这些对象

主要是可读性问题。一般情况下。

5.不需要打印日志

日志在AOP里面会打印，而且我的建议是大部分日志在Services这层打印。

规范里面大部分是不要做的项多，要做的比较少，落地比较容易。

ResultBean定义带泛型，使用了lombok。