Apache Thrift生成的Java struct类如何额外实现自定义接口？

Thrift本身原生支持该能力，不需要手动修改生成后的代码，具体操作如下：

方法一：使用java.implements注解（推荐，Thrift 0.9.3及以上版本支持） #

这是最简便的方案，直接在.thrift文件的结构体定义后添加注解即可：

• 注解值需要写自定义接口的全限定类名，避免生成代码时出现包导入错误
• 支持同时指定多个接口，用逗号分隔即可

示例.thrift代码：

// 定义Java生成类的包名，可根据你的项目调整
namespace java com.example.yourproject

struct ATypeRequest {
  // 这里写你的字段定义
  1: required String userId
} (java.implements = "com.example.yourproject.MyRequest")

struct BTypeRequest {} (java.implements = "com.example.yourproject.MyRequest")

struct CTypeRequest {} (java.implements = "com.example.yourproject.MyRequest")

生成后的Java类会自动追加实现指定的接口，示例生成代码：

public class ATypeRequest implements TBase<ATypeRequest, ATypeRequest._Fields>, MyRequest {
  // Thrift自动生成的其他代码
}

方法二：自定义代码生成模板（适用于Thrift版本低于0.9.3的场景） #

如果你的项目使用的Thrift版本较低没有java.implements特性，可以修改Thrift编译器的Java代码生成模板：

• 找到Thrift源码中Java语言的结构体生成模板文件
• 在模板中implements TBase的位置追加你的自定义接口全限定名
• 重新编译Thrift编译器后再生成代码即可

注意事项 #

• 自定义接口的方法签名不要和Thrift生成的类自带方法（比如read、write、validate、getFieldValue等）冲突，否则会出现编译错误
• 如果自定义MyRequest包含抽象方法，有两种处理方案：
  • Java 8及以上版本可以把接口方法定义为default方法，无需修改生成类
  • 配合Thrift的java.member注解，给结构体追加自定义方法实现，示例：

    struct ATypeRequest {} (
      java.implements = "com.example.yourproject.MyRequest",
      java.member = "public boolean checkParam() { return userId != null; }"
    )
    

• 如果需要给所有结构体统一加同一个接口，也可以写简单的正则脚本批量给.thrift文件的所有struct追加注解，避免手动逐个修改的麻烦

内容的提问来源于stack exchange，提问作者Liu