Mobility
·
RPC接口将所有输入输出封装成类是合理设计吗
💡
原文中文，约1500字，阅读约需4分钟。
📝
内容提要
RPC接口的输入输出封装成类的设计并不总是合理。仅在输入参数过多时才应考虑封装，且封装可能降低代码可读性。输出结果封装相对合理，但不应强迫调用方了解所有异常情况。设计接口时需谨慎考虑封装的必要性。
🎯
关键要点
- RPC接口的输入参数仅在过多时才应考虑封装，其他情况下不需要封装。
- 封装输入参数可能导致代码可读性降低，语义不明确。
- 接口提供方应保证后续修改向前兼容，避免强迫调用方增加必传字段。
- 输出结果封装相对合理，但不应强迫调用方了解所有异常情况。
- 设计接口时需谨慎考虑封装的必要性，避免盲目封装所有输入和输出参数。
❓
延伸问答
RPC接口的输入参数什么时候应该封装成类？
仅在输入参数过多时才应考虑封装，其他情况下不需要封装。
封装输入参数可能带来哪些问题？
封装可能导致代码可读性降低，语义不明确。
如何保证接口的向前兼容性？
接口提供方应保证后续修改向前兼容，避免强迫调用方增加必传字段。
输出结果封装成response体的合理性如何？
输出结果封装相对合理，但不应强迫调用方了解所有异常情况。
设计RPC接口时需要注意哪些原则？
设计接口时需谨慎考虑封装的必要性，避免盲目封装所有输入和输出参数。
为什么不应该强迫调用方了解接口的异常情况？
如果调用方不关心请求成功或失败的原因，就不应强迫其了解这些信息。
➡️
