Code-First
Hot Chocolate 之间和Pure Code-First
或Annotation-Based
在Hot Chocolate中的区别是什么?在 GraphQL 模式视角和 Hot Chocolate 内部,每种编码方法的优缺点是什么?
2 回答
Pure Code First
被重命名为Annotation Based
. 所以这两个是一样的。
这取决于您最终将使用的架构和品味。您不必拘泥于代码优先或基于注释,您也可以混合搭配。
HotChocolate 默认推断所有属性及其类型。这意味着,当您返回 aUser
时,它将自动为它创建一个类型,其中包含用户拥有的所有属性。如果您想更改类型的配置,您可以使用注释或创建 ObjectType`
在引擎盖下,所有方法(甚至首先是模式)都具有相同的表示。它们都被转化为code-first
方法。
在代码优先的方法中,您使用类型继承和流畅的 API 来配置类型
public class User
{
public string Id {get; set}
}
public class UserType : ObjectType<User>
{
protected override void Configure(IObjectTypeDescriptor<User> descriptor)
{
descriptor.Field(x => x.Id).Type<IdType>();
descriptor.Field<Resolvers>(x => x.GetAddressAsync(default, default));
}
public class Resolvers
{
public Task<Address> GetAddressAsync(
[Parent]User user,
[Service]AddressRepo repo) => repo.GetAddressByUserAsync(user.Id);
}
}
在基于注解的方法中,您可以使用注解来自定义类型:
public class User
{
[GraphQLType(typeof(IdType))]
public string Id {get; set}
}
[ExtendObjectType(nameof(User))]
public class UserAddressExtensions
{
public Task<Address> GetAddressAsync(
[Parent]User user,
[Service]AddressRepo repo) => repo.GetAddressByUserAsync(user.Id);
}
尽管这两种方法同样强大并且具有相同的功能,但使用其中一种方法还是有一定的好处。
如果您无权访问域模型,或者不想向它们添加属性,您可能会发现代码优先方法更易于使用。当您想退出类型推断并指定要在架构中公开哪些字段时,情况也是如此。
基于注释的方法通常可以保护大量的样板代码,如果您先编写代码,您将需要这些代码。如果您发现自己在 api 上公开的属性多于隐藏的属性,您可能会发现基于注释的方法更优雅。通常,如果您使用注解,您的代码会更少且更清晰
我们经常看到的是两种方法的结合。GraphQL 域中的所有内容都使用注释并配置域模型,使用代码优先类型。
尽管使用 11.2 中发布的新属性,您甚至不再需要代码优先类型。您还可以使用属性和类型扩展更改、忽略或替换字段。您还可以使用https://chillicream.com/docs/hotchocolate/defining-a-schema/extending-types/[UnionType]
定义联合和接口[InterfaceType]
基于注释或纯代码优先:在这种方法中,我们不关心 GraphQL 模式类型,我们只需编写干净的 C# 代码,自动转换为 GraphQL 类型。
代码优先:在这种方法中,我们使用Schema types
Schema类型允许我们将 GraphQL 类型配置与我们的 .NET 类型分开。当我们不希望我们的业务对象有任何 Hot Chocolate 属性时,这可能是正确的方法。