Question

考虑以下示例

@Remote
public interface RegistrationService {
    public String register();
    public void unregister(String id);
    public void heartbeat(String id);
}

@Stateless
@Remote(RegistrationService.class)
public class RegistrationServiceBean implements RegistrationService {
    /* ... */
}

我有一个界面，让我们说 RegistrationService 。有了这个，远程客户端就可以将自己注册到应用程序中。通过定期调用 heartbeat（），它会发出信号表明它仍处于活动状态。

记录EJB及其接口的正确方法是什么？

例如：

接口

此界面的用户可以将自己注册到应用程序中。然后，应用程序重新计算要均匀分布的内容所有注册客户。 （这将涉及知识其他类，例如重新计算类
接口的用户可以注册自己并通知服务器（如果是）仍然连接。该实现使用此信息进行发布基于注册量的基础系统的任务客户（这不涉及其他类的知识，但是从应用程序的角度来看并不是那么精确）

类

当客户端注册，取消注册或心跳过期时，RegistrationService的此实现会在RecalculationClass中重新计算重新计算。这是必要的，因为数据必须在客户端之间平均分配。

任何想法都赞赏。感谢。

斯文

Answer 1

接口javadoc应该没有关于实现的信息。接口是关于什么，而不是如何。

例如，实现完全忽略对接口方法的调用是有效的 - 即有一个空方法。

你的javadoc应该说：Notifies that the specified application is still alive。实现选择做的信息取决于它。

Answer 2

我想说这取决于哪个信息对客户来说很重要。如果重新计算对用户完全是不可见的，则可能不需要在界面中对其进行记录。如果客户端以某种其他方式可以看到重新计算细节，则必须在此处指出，以便用户知道可能发生哪些交互。如果重新计算完全是内部的，并且可以在客户不注意的情况下进行更改，则不需要也不应该在界面描述中。

如何为EJB及其接口编写Javadoc？

2 个答案: