打破java泛型命名约定？

Question

我有一个接口，其声明如下：

/**
* @param T - the type of entity.
* @param C - the type of entity container will be returned.
*/
public interface FindByNamedQuery<T extends Serializable, C extends Collection<T>> extends Command {
    C executeNamedQuery(String namedQuery);
}

我想知道我是否可以（应该）打破Java命名约定来做到这一点：

public interface FindByNamedQuery<ENTITY_TYPE extends Serializable, RETURNED_CONTAINER extends Collection<ENTITY_TYPE>> extends Command {
    RETURNED_CONTAINER executeNamedQuery(String namedQuery);
}

Answer 1

自 20 世纪 90 年代中期以来，我开始不同意单字符约定。

我发现可读的名称更具可读性。这有助于理解泛型类型的实现和接口。

对于 Java 来说，歧义问题似乎被夸大了。很少有类名是全大写的。常量不与类名在同一上下文中使用。

@param JavaDoc 元素确实可以提供更长的描述。但 JavaDoc 不一定是可见的，这也是事实。 （例如，Eclipse 中有一个显示类型参数名称的内容辅助。）例如

，将 :

public final class EventProducer<L extends IEventListener<E>,E> 
    implements IEventProducer<L,E> {

与:

public final class EventProducer<LISTENER extends IEventListener<EVENT>,EVENT> 
    implements IEventProducer<LISTENER, EVENT> {

进行比较，尽管 Sun/Oracle 已推荐使用单字符名称作为约定，但约定可以更改。挑战这一惯例的后果很小。如果您和您的团队更喜欢为类型参数指定有意义的名称，我个人会选择它。

编辑 (2015)

Google style for Java 允许单字母名称和多字符类- 类似以 T 结尾的名字。

5.2.8 类型变量名称

每个类型变量都以两种样式之一命名：

• 单个大写字母，可选后跟单个数字（例如 E、T、X、T2）

• 用于类的形式的名称（请参阅第 5.2.2 节，类名称），后跟大写字母 T（例如：RequestT、
  FooBarT）。

Answer 2

我想知道我是否可以（应该）打破 java 命名约定来做到这一点：

不，应该避免这种情况，因为它更容易将类型参数与常量和其他参数混淆标识符。

以下是泛型官方跟踪的引用：

类型参数命名约定

按照惯例，类型参数名称是单个大写字母。这与您已经了解的变量命名约定形成鲜明对比，并且有充分的理由：如果没有此约定，将很难区分类型变量和普通类或接口名称.

最常用的类型参数名称是：

• E - 元素（由 Java 集合框架广泛使用）
• K - 键
• N - 数字
• T - 类型
• V - 值
• S、U、V 等 - 第二、第三、第四类型

您将在整个 Java SE API 以及本教程的其余部分中看到这些名称。

Answer 3

在 C# 中使用 TDescription 非常常见。它保留了 T 名称，但同时也是描述性的，如下所示：

public interface FindByNamedQuery<
    TEntityType extends Serialiazble, 
    TReturnedContainer extends Collections<TEntityType>> extends Command 
{     
    TReturnedContainer executeNamedQuery(String namedQuery); 
} 

正如其他人所说的 ALL_CAPS 几乎总是表示一个常量。

IMO，“很难区分类型变量和普通类或接口名称之间的区别。”此处不适用，因为 T 前缀很容易将其标识为类型变量。

同样，这是 C#，但请参阅 MSDN：泛型命名约定

在所有其他情况下，官方
Microsoft 通用指南
命名约定是：

• 使用描述性名称命名泛型类型参数，除非单个
  字母名称完全是自我
  解释性和描述性名称
  不会增加价值。

  公共接口ISessionChannel 
  {...}
  
  公共委托 TOutput Converter(TInput from);
  

• 考虑在参数名称中指示对类型参数施加的约束。例如，限制为 ISession 的参数可以称为 TSession。

Answer 4

编译器可能不会抱怨，但你的队友可能不喜欢你在他们需要类型参数的地方使用看起来像常量的东西。

Answer 5

我认为这是许多使用仿制药的人的抱怨。我不太同意 Sun 的说法，即如果您使用完整的名称，那么它将与现有的类名称或其他名称混淆。在这种情况下，我们可以像这样以美元开头占位符名称：

public class HashMap<$Key,$Value> implements Map<$Key,$Value>{}

没有一个头脑清醒的人会以美元符号开头命名类。美元符号也用于表示许多模板语言的占位符，例如 Velocity、Struts、Spring 等。我认为这是正确的方法。

如果有人感兴趣的话，我在我的博客文章中获得了有关此内容的更多详细信息以及不必使用单个字母符号背后的原因。

http://readsethu. wordpress.com/2012/05/23/a-generic-class-and-why-is-it-confusing/

Answer 6

就像 Allen 之前一样，我的建议更多来自 C#（我使用从 5 个月以来广泛使用）比 Java（我使用过它，但它从来没有走得太远......），但我发现 Java 和 C# 代码在精神上非常相似（也就是说，当比较时，比如说， C++）

无论如何，当在简单类型上使用 C#/Java 泛型（或 C++ 模板）时，我通常使用 T：

// C++
template<typename T>
class MyClass { /* ... */ } ;
// C#
public MyClass<T> { /* etc. */ }
// Java
public MyClass<T> { /* etc. */ }

通常，类型 T 与类一起使用，因此无需对其进行更多描述。

但当真正描述类型可以增加代码清晰度时，我就会这样做。

或者，当我在同一泛型/模板声明中有两种或多种类型时，它有助于区分两种类型。例如（C# 中的现实生活示例）：

// C++
template<typename T_Data, typename T_Underlying>
class MyClass { /* ... */ } ;
// C#
public MyClass<T_Data, T_Underlying> { /* etc. */ }
// Java
public MyClass<T_Data, T_Underlying> { /* etc. */ }

这样，很容易区分代码中的两个类型名称，其中 T 和 U 是很好的。 .. 有点匿名：对于那些使用 Visual C++ 的人来说，在 Dinkumware 的 STL 代码中进行调试（充满 T、_U 和其他单字母类型名称）可能会非常令人沮丧。 ..我想也是一样适用于 C# 或 Java 代码。

您会注意到，在每种情况下（C++、Java 或 C#），我在类型命名中都没有遵循约定：原因是有时，您只需尝试其他方法而不是随波逐流，即使在到最后，你会发现你错了。

在目前的情况下，违反命名约定并不重要（Java 中存在比这种小犯罪更严重的问题），最后，您将亲自了解为什么它是错误的，而不是引用旧文档。

如果你最终发现你是对的，那么......

Answer 7

我会以类似于类型的方式命名类型变量，采用驼峰式大小写，但以“_”为前缀。

public interface FindByNamedQuery
    <_EntityType extends Serialiazble, 
     _ReturnedContainer extends Collections<_EntityType>> 
    extends Command 
{
    _ReturnedContainer executeNamedQuery(String namedQuery);
}