java - 如何在事件处理程序和回调中处理版本化对象

Question

我的问题:
是否有一种最著名的方法来处理已在处理程序或回调中反序列化的对象的不同版本？

一些背景信息:
我们将使用序列化对象作为消息在软件套件中的各个组件之间进行通信。这些可以是 JSON 形式或使用类似 protobufs 的形式。 。每当您开始序列化对象时，无论是为了长期存储还是在应用程序的不同版本之间，您都必须能够处理这些对象的不同版本(可能使用 Annotations-Java 或 Attributes-C#)。
我试图避免这样的代码:

onRecvMyMsg(MyMsg msg)
{
  if (msg.version == 1.0)
    // process it here
  else if (msg.version < 1.5)
    // process it here 
  else if (msg.version < 2.0)
    // process part of it in the 1.5 handler and the other part here
  else if // etc...
}

在进行了许多添加/增强/更改之后，这似乎将是一场维护噩梦......
当然，肯定有人已经解决了这个问题，因为这似乎是软件工程中非常常见的做法。任何帮助或建议将不胜感激!

Answer 1

我原来的方法的问题在于解决方案的方向是错误的。我们认为处理实体或对象的使用者需要知道版本，以便能够正确处理它们之间的差异。 相反，我们可以考虑的是如何让对象根据处理器(或消费者)的版本来表达自己。

如果我们使用像 Protocol Buffers 这样的序列化技术, Apache Thrift ，或Apache Avro我们已经成功一半了。从某种意义上说，像这样的库为我们处理版本控制。一般来说，他们的行为是这样的:

• 如果接收到字段但未定义，则简单地删除该字段
• 如果定义了某个字段但未接收到，则会有一个标志表明它是不存在并且可以提供可选的默认值

这些库还支持“必填”字段；然而，大多数人(包括作者)不建议在协议(protocol)对象本身上使用“必填”字段，因为如果不存在“必填”字段，“必填”字段将破坏所有时间的可比性，无论是发送还是接收。他们建议在处理端处理必填字段。

由于提到的库以向后和向前兼容的方式处理序列化和反序列化对象所需的所有工作，因此我们真正需要做的就是将这些协议(protocol)对象包装到可以以消费者期望的形式公开数据的其他东西中。
例如，以下是可以处理的同一消息的 3 个版本。

ReviewCommentMsg // VERSION 1
{
 string : username
 string : comment
} 

ReviewCommentMsg  // VERSION 2 (added "isLiked")
{
 string : username
 string : comment
 bool   : isLiked
} 

ReviewCommentMsg  // VERSION 3 (added "location", removed "isLiked")
{
 string : username
 string : comment
 string : location
}

下面演示了我们如何逐步更新客户端代码来处理这些消息。

/*******************************************************************************
  EXAMPLE OBJECT V1
*******************************************************************************/
class ReviewComment
{
  private final String username;
  private final String comment;

  ReviewComment(ReviewCommentMessage msg)
  {
    // Throws exception if fields are not present.
    requires(msg.hasUsername());
    requires(msg.hasComment());

    this.username = msg.getUsername();
    this.comment = msg.getComment();
  }

  String getUsername() { return this.username; }

  String getComment()  { return this.comment; }
}

/*******************************************************************************
  EXAMPLE PROCESSOR V1
*******************************************************************************/
public void processReviewComment(ReviewComment review)
{
  // Simulate posting the review to the blog.
  BlogPost.log(review.getUsername(), review.getComment());
}


/*******************************************************************************
  EXAMPLE OBJECT V2
*******************************************************************************/
class ReviewComment
{
  private final String username;
  private final String comment;
  private final Boolean isLiked;

  ReviewComment(ReviewCommentMessage msg)
  {
    // Throws exception if fields are not present.
    requires(msg.hasUsername());
    requires(msg.hasComment());

    this.username = msg.getUsername();
    this.comment = msg.getComment();

    if (msg.hasIsLiked())
    {
      this.isLiked = msg.getIsLiked();
    }
  }

  String getUsername() { return this.username; }

  String getComment()  { return this.comment; }

  // Use Java's built in "Optional" class to indicate that this field is optional.
  Optional<Boolean> isLiked() { return Optional.of(this.isLiked); }
}

/*******************************************************************************
  EXAMPLE PROCESSOR V2
*******************************************************************************/
public void processReviewComment(ReviewComment review)
{
  // Simulate posting the review to the blog.
  BlogPost.log(review.getUsername(), review.getComment());

  Optional<Boolean> isLiked = review.isLiked();

  if (isLiked.isPresent() && !isLiked.get())
  {
    // If the field is present AND is false, send an email telling us someone
    // did not like the product.
    Stats.sendEmailBadReview(review.getComment());  
  }
}


/*******************************************************************************
  EXAMPLE OBJECT V3
*******************************************************************************/
class ReviewComment
{
  private final String username;
  private final String comment;
  private final String location;

  ReviewComment(ReviewCommentMessage msg)
  {
    // Throws exception if fields are not present.
    requires(msg.hasUsername());
    requires(msg.hasComment());
    requires(msg.hasLocation());

    this.username = msg.getUsername();
    this.comment = msg.getComment();
    this.location = msg.getLocation();
  }

  String getUsername() { return this.username; }

  String getComment()  { return this.comment; }

  String getLocation()  { return this.location; }
}

/*******************************************************************************
  EXAMPLE PROCESSOR V3
*******************************************************************************/
public void processReviewComment(ReviewComment review)
{
  // Simulate posting the review to the blog.
  BlogPost.log(review.getUsername(), review.getComment());

  // Simulate converting the location into geo coordinates.
  GeoLocation geoLocation = GeoLocation.from(review.getLocation());

  // Simulate posting the location to the blog.
  BlogPost.log(review.getUsername(), geoLocation);
}

在此示例中:
处理器 V1 可以接收消息(V1、V2 和 V3)
处理器 V2 可以接收消息(V1、V2 和 V3)
处理器 V3 可以接收消息(V3)

这种方法将兼容性问题放在消息对象本身中，并减轻了客户端/处理器进行大量版本检查的负担。
诚然，你仍然需要执行一些语义检查；然而，这似乎比为每个客户端构建版本逻辑要简单得多。