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

Question

我有一个 SearchService，它使用一种算法来查询数据库并返回结果。有几种不同的数据可以返回格式，这取决于调用者希望从服务中得到什么。这些格式是:

• 与数据库中的表直接匹配的实体列表
• 匹配记录的主键列表(Longs)
• “搜索结果”列表，由一系列字段组成，这些字段通常与用户希望从搜索结果中看到的内容相关(比如人名、地址电话号码等)

目前我的 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);