返回具有相似参数的不同类型的方法的命名约定

Question

我有一个 SearchService，它使用一种算法来查询数据库并返回结果。数据可以以多种不同的格式返回，具体取决于调用者想要从服务中获得什么。这些格式是：

• 直接与数据库中的表匹配的实体列表
• 匹配的记录的主键（长整型）列表
• “搜索结果”列表，由一组通常与以下内容相关的字段组成用户希望从搜索结果中看到什么（例如人名、地址、电话号码等）

目前我的 SearchService 如下所示：

public interface SearchService {
    public List<People> searchPeopleReturnEntity(SearchRequest request);
    public List<Long> searchPeopleReturnId(SearchRequest request);
    public List<SearchResult> searchPeopleReturnSearchResult(SearchRequest request);
}

我正在寻找有关此方面最佳实践的建议。目前，命名约定似乎相当笨拙，我相信有比我现在更好的解决方案。

Answer 1

我将它们称为简单的名称，例如 getPeople、getIds、getSearchResults。

如果您需要对除人之外的实体使用这 3 个相同的方法，我会考虑制作一些通用的中间类型来定义它们，允许您编写如下内容：

List<People> people = service.getPeople(request).asEntities();
List<Long> fooIds = service.getFoos(request).asIds();

// or something like this
List<People> people = service.searchPeople().getEntities(request);

Answer 2

我将它们称为 findPeople()、findPeopleIDs() 和 findPeopleResults()。

Answer 3

如果您的服务还可以返回其他实例（除了 People），我会将它们命名为

• findPeopleEntities()
• findPeopleIds()
• getSearchResult() 或 getPeopleSearchResult() （您通常找不到搜索结果；） )

如果 SearchResult 仅用于人员，我还将其命名为 PeopleSearchResult。否则，我会给它一个通用参数，例如 SearchResult ，然后 List> getPeopleSearchResult()。

Answer 4

或者您可以使用 searchBy... 方法？尽管我同意这表示您将返回相同的结果。
也许你可以重构一下：

• search... 将返回一个列表（我猜测 ID 在数据库中？），
• 然后添加一个 getPeople( List )，它实际上返回这些 ID 的对象列表，

因此你的 search... 方法总是返回 ID，然后您有专门的函数将它们转换为“正确的”搜索结果？

Answer 5

如果不是很明显，这种方法没有真正的“最佳实践”命名方案。

Answer 6

一种想法可能是：

public <T> T findPeople(SearchRequest request, Class<T> resultClass);

然后您可以根据 resultClass 是 Person.class、Long.class 还是 SearchResult.class 返回不同的内容。

或者，不那么可怕的是，您可以这样做：

public <T> T findPeople(SearchRequest request, ResultConverter<T> resultConverter);

其中 ResultConverter 是一个接口，它接受某种原始搜索结果并返回合适的转换结果。您可以为常见的实例提供固定的实例：

public class ResultConverters {
    public static final ResultConverter<Long> ID;
    public static final ResultConverter<Person> PERSON;
    public static final ResultConverter<SearchResult> SEARCH_RESULT;
}