Design patterns 一个API方法做两件事；这是创建API时的良好实践吗？
我的同事和我在服务的设计上有点分歧，我需要社区的帮助来确定正确的做法 上下文：我们正在创建一项服务，允许画家/插图画家在云中存储图像。一组图像构成一个图像包 场景：我们正在尝试添加将艺术家与图像包关联的逻辑。我们目前已经有了一个API，允许我们创建图像包（只不过是一个指向图像的链接，带有名称和描述）。我们没有创建艺术家的API，也没有将艺术家与图像包关联的API 他的视角：在调用createImagePack时添加以下参数[artist\u id、artist\u name、artist\u desc]。如果艺术家id为“null”，我们将使用艺术家名称和艺术家描述在系统中创建新的艺术家，并自动将他/她分配给新创建的图像包。然后API将以图像包id和艺术家id进行响应 我的观点：上述方法混合了各种顾虑，增加了管理和更新createImagePack API的风险，并打破了“API应按其名称行事”的一般经验法则。[我们可以将名称更新为createImagePackapiandCreateArtitifArtistidNotNull，但也有一些代码气味]。我们应该将这两个调用分开，使它们成为独立的API，并创建一个门面来支持艺术家和图像的一次性创建 我是不是分析过度了？他们关于什么是最好的行动方针的优秀评论是什么Design patterns 一个API方法做两件事；这是创建API时的良好实践吗？,design-patterns,api-design,Design Patterns,Api Design,我的同事和我在服务的设计上有点分歧，我需要社区的帮助来确定正确的做法 上下文：我们正在创建一项服务，允许画家/插图画家在云中存储图像。一组图像构成一个图像包 场景：我们正在尝试添加将艺术家与图像包关联的逻辑。我们目前已经有了一个API，允许我们创建图像包（只不过是一个指向图像的链接，带有名称和描述）。我们没有创建艺术家的API，也没有将艺术家与图像包关联的API 他的视角：在调用createImagePack时添加以下参数[artist\u id、artist\u name、artist\u d
更新：我们的系统中确实有“用户”的概念，因此另一种方法是创建一个关联表，在其中关联用户id，将id打包到艺术家打包映射表中。这避免了为艺术家创建单独的实体，并将我们与我们的“用户”概念松散地联系在一起，因为我们的“用户”概念没有任何强类型。我认为将关注点混合在一种方法中不是一个好主意。一种方法应该做一件事（例如createImagePack、CreateArtister、associateImagePack、DeleteArtister等）。然而，您可以做的是将对逻辑相关方法的调用组合成一个方法调用，以使用Façade模式创建复合功能 在façade类中，您将有一个定义如下的方法：
public Artist createImagePackAndArtist(String artist_name, String artist_desc){
ImagePack imagePack = new ImagePack();
Artist artist = new Artist(artist_name, artist_desc);
artist.associateImagePack(imagePack);
return artist;
}
public void createImagePackForArtist(Artist artist){
ImagePack imagePack = new ImagePack();
if (artist != null) {
artist.associateImagePack(imagePack);
} else {
// throw ArtistIsNullException
}
}
还可以看看工厂模式。您可以实现这一点，而不是自己创建对象。还可以看看单例模式。立面和工厂通常是单体的。我认为将关注点混合在一种方法中不是一个好主意。一种方法应该做一件事（例如createImagePack、CreateArtister、associateImagePack、DeleteArtister等）。然而，您可以做的是将对逻辑相关方法的调用组合成一个方法调用，以使用Façade模式创建复合功能 在façade类中，您将有一个定义如下的方法：
public Artist createImagePackAndArtist(String artist_name, String artist_desc){
ImagePack imagePack = new ImagePack();
Artist artist = new Artist(artist_name, artist_desc);
artist.associateImagePack(imagePack);
return artist;
}
public void createImagePackForArtist(Artist artist){
ImagePack imagePack = new ImagePack();
if (artist != null) {
artist.associateImagePack(imagePack);
} else {
// throw ArtistIsNullException
}
}
还可以看看工厂模式。您可以实现这一点，而不是自己创建对象。还可以看看单例模式。立面和工厂通常是单体的。系统及其API应该
- 显而易见
- 可预测的
- 和沟通