HibernateUtil 类的通用名称是什么？

Question

我有一个 HibernateUtil 类，它是本书 (Hibernate in action) 类的标准。
它获取一个会话，刷新并关闭它。开始、提交和回滚事务并构建 sessionFactory。
目前，我们的包中这被错误地称为 HibernateSessionFactory。
我想将其重构为更合适的名称，但 HibernateUtil 这个名称让我烦恼，因为我想选择一个更通用的名称，例如 PersistentManagerUtil。
关于这样的名字有一个好的java约定或共识吗？

编辑 我想让它更通用的原因是我想最大限度地减少对特定 ORM 实现的“暴露”。该类的大多数公共方法都将 void 作为返回类型，因此它们不返回 Hibernate 类/接口。唯一的例外是 getSession，它返回 org.hibernate.Session。我之所以考虑这个方向是因为我想切换到JPA并使用hibernate作为实现，因此有更多的自由度。 为什么不将其更改为 EntityManagerUtil？正如 hibernate 的文档中所说，EntityManager 相当于 Session，EntityManagerFactory 相当于 HibernateSessionFactory。

预先感谢，
一泰

Answer 1

不要让它变得更通用，除非这个类除了与 Hibernate 对话之外真的可以做任何事情。它在其公共 API 中使用 Hibernate 类和接口，对吧？只要它是 Hibernate 特定的（在接口和实现方面），最好通过其名称让每个人都了解它。

HibernateUtil 听起来不错。

该类的大多数公共方法都将 void 作为返回类型，因此它们不返回 Hibernate 类/接口。唯一的例外是 getSession，它返回 org.hibernate.Session。我之所以考虑这个方向是因为我想切换到JPA并使用hibernate作为实现，因此有更多的自由度。

好吧，一旦摆脱了 getSession，您就可以将名称更改为 JpaUtil。

Answer 2

您的类是 Hibernate 特定的，因此最好将其包含在其名称中。

它会创建会话，还是从其他地方获取会话？如果它创造了它们，Factory 也是一个好名字。如果没有，听起来它管理会话，那么“HibernateSessionManager”怎么样？

你的名字“HibernateUtil”太笼统了。我总是将“util”包和类视为代码味道；它们通常会突然出现，因为设计师有一堆他/她不知道该放在哪里的东西。你的课程不是这样的，它显然专注于休眠会话的管理。

至于你关于命名的现有约定或共识的问题。有一些准则（但您可能已经知道它们）：

• 方法应该反映它们所在的类上的操作，并且如果可能的话具有逻辑参数顺序。示例：ChessBoard.swapPlayers(Player a, Player b)
• 对于返回布尔值的方法，使用 isActivated 或 hasPlayers 等谓词
• 另一种风格是方法链接，其中链接的方法读起来有点像英文句子：verify(mockedList, atLeastOnce()) .add("三次"); (mockito)
• 有关方法的 JavaDoc 应该描述动作，例如：交换玩家 A 和 B，以便他们用彼此的棋子继续游戏”。
• 类应该代表一个具有明确责任的“事物”。示例：StringBuilder、Customer、PdfServlet。如果次要责任蔓延到一个类中，这通常意味着它应该被重构为两个协作类。
• 类上的 JavaDoc 应该描述“事物”，并且应该描述它的主要职责，因为它通常不应该描述对客户端有价值的信息。在公共 JavaDoc 中。

哦，是的，我碰巧认为命名对于良好的软件设计非常重要，但我想这已经很清楚了（-：

编辑：响应您的编辑。只要它返回 Hibernate 类型，它就可以了。仍然是 Hibernate 特定的。如果您设法完全从 Hibernate 抽象到 JPA，那么将其命名为 JpaSessionManager（如果您愿意，也可以称为 JPASessionManager）是有意义的。但这需要返回仅 JPA 的会话对象。