|
|
% c1 o: y1 M% E% G& q<h2 id="系列导航">系列导航</h2>
9 d; g9 U7 k% {% f<p><a href="https://www.cnblogs.com/code4nothing/p/graphql-net6-0.html">使用Hot Chocolate和.NET 6构建GraphQL应用文章索引</a></p>
, N- n9 b" B. ~- Q<h2 id="需求">需求</h2>: Z& z' E: t9 b, q, t9 I& I
<p>在讨论完GraphQL中的查询需求后,这篇文章我们将演示如何实现GraphQL中的数据添加任务。</p>
- q0 P, v; \' s9 d) _, q: z<h2 id="思路">思路</h2>
: V. B3 y3 W8 w6 C$ l8 k; Q<p>在GraphQL中,对数据进行查询使用<code>query</code>,而对于修改数据则需要使用<code>mutation</code>,包括新增和修改数据。Hot Chocolate在使用Mutation的逻辑上和使用Query的基本一致,但是需要根据需要定义用于创建或者更新的数据对象,所以我们直接进行实现。</p>+ [! E. W& v3 f% {5 C8 I1 {- ~ r
<h2 id="实现">实现</h2>. ]0 e, A* A( O- A1 y
<p>为了保持简单,我们先定义以下两个类型:</p>
0 c* Z3 G% Y# F2 O( [ m% _& y<pre><code class="language-c#">// 定义新增Post的参数
* `) K1 J6 f# e1 h) _ Rpublic record AddPostInput(string Title, string Author);2 A3 W9 Y2 a+ g
- T3 s7 i& m& W// 定义新增Post的返回对象
3 `: @$ X/ O! e4 [. B; T( rpublic record AddPostPayload(Post Post);
& s& F* n4 [1 J0 p" ]6 v* g4 u</code></pre>' a# y6 H7 F2 E
<p>新建<code>Mutation.cs</code>用来定义相关接口:</p>8 I3 V9 y2 \3 I2 b Q7 p2 R5 r$ q
<ul>% y1 |4 I/ Y }3 d- \8 b
<li><code>Mutation.cs</code></li>
6 M5 \& M& `0 p</ul>
8 {- b0 D$ u9 v/ X& N1 }: O( g<pre><code class="language-c#">namespace PostGraphi.Api.GraphQL;
* ?& r8 r K. |" |6 c( X, X
4 q8 ~1 D- Q3 D g! K9 wpublic class Mutation+ [% ^7 w0 ?. f; y8 J
{
8 h6 O% |& F n2 j- A6 c! y5 J; H public async Task<AddPostPayload> AddPostAsync(AddPostInput input, [Service] IRepository<Post> repository)3 v0 F5 l9 E/ X3 A0 o8 g
{
! Y5 C0 Z* T' F! q& T return new AddPostPayload(await repository.AddAsync(new Post
' W) u2 r" m. G$ i {
; `1 J1 J4 [" B, V$ |9 u Title = input.Title,
* O6 ]1 v. X! h4 D9 i; s! L Author = input.Author0 h' a% q" V- Z& l/ Z( K
}));
$ P' L9 w1 w5 z; [5 J( w$ E }
: u5 q2 t# y' D( y) r" \) s# x}
( z+ t I+ ]% E! S: |2 k3 l' K' u# ~9 P, ~
</code></pre>% T2 g6 Q( _ U5 {- o- g% L
<p>最后在注入服务的地方进行配置:</p>
3 P! B- d% |5 ~9 S; _5 ^<ul>
) c5 E1 N% t) S3 D8 S% p0 U/ S<li><code>ProgramExtensions.cs</code></li>
6 p5 W% x3 P2 G, o# u0 f& ]</ul>
- C- A6 z W3 O4 { m/ c<pre><code class="language-c#">builder.Services
4 u7 ~# n5 p/ p0 @2 O. V .AddGraphQLServer()! Y- u' z" V; i
.SetPagingOptions(new PagingOptions
& k9 ^ [. G6 [: S {
/ q/ n! W# W, U/ m% W2 z MaxPageSize = 50,/ W/ b" i5 Y2 u( _
IncludeTotalCount = true p; }! L) F! K
}); E! ~+ [( u9 a$ U3 K
.AddFiltering()
N& Y1 E6 Q" z: A, B .AddProjections()
- |8 ~( W* m" ~8 S .AddSorting()
7 N8 J' t1 G/ ?. M2 p$ q .AddQueryType<Query>(). @. V3 A7 | J h7 b4 H
.AddMutationType<Mutation>()3 H f) ^8 W7 E8 S
.AddMutationConventions(new MutationConventionOptions& d @: \5 ^& h4 Y. O1 j8 F
{9 J3 b# n- j( u; r( Q
ApplyToAllMutations = true,. ?+ k. i. q: i
InputArgumentName = "input",/ N& b; {, e/ {. y
InputTypeNamePattern = "{MutationName}Input",
% x/ k' } Q$ o6 k# g0 ^ PayloadTypeNamePattern = "{MutationName}Payload",3 i6 f1 ], k8 A* A4 A2 c+ Q
PayloadErrorTypeNamePattern = "{MutationName}Error",& _9 Z$ C4 K( j! j5 t# T* y4 @% _
PayloadErrorsFieldName = "errors"1 t+ `' X. J6 J1 B, M8 C7 \6 @
})
$ T; n* g) ~8 p, K& d/ [1 C .AddType<PostType>();
( {- A5 I D1 q7 {5 h</code></pre>
/ T" P5 ^) i1 `5 k3 p+ @% j% q8 a<p>这样就实现了新增Post的需求,下面我们来验证一下。</p> q$ [/ d' a2 y+ a5 @
<h2 id="验证">验证</h2>/ |5 H2 _" P$ k- \- {% j/ s) ~- V4 n
<p>启动<code>Api</code>项目,调用接口:</p>8 {8 D/ m( J8 D" r! ?" M! M6 W+ ~
<p><img src="https://img2022.cnblogs.com/blog/2487237/202202/2487237-20220211104544617-1400586374.png" ></p>8 W ]0 P" M0 u! H! {* H- s
<p>终端的日志输出如下:</p>" m- L w$ n8 m- E( |) g. D
<pre><code class="language-bash">[10:45:15 INF] Executed DbCommand (1ms) [Parameters=[@p0='?' (DbType = Guid), @p1='?', @p2='?' (Size = 13), @p3='?', @p4='?' (DbType = DateTime), @p5='?', @p6='?' (DbType = DateTime), @p7='?', @p8='?', @p9='?' (DbType = DateTime), @p10='?' (Size = 30)], CommandType='Text', CommandTimeout='30']
1 k( F$ `& v ~6 ~4 d3 NINSERT INTO "Posts" ("Id", "Abstraction", "Author", "Content", "Created", "CreatedBy", "LastModified", "LastModifiedBy", "Link", "PublishedAt", "Title"); W& K$ y% m% _0 l, G
VALUES (@p0, @p1, @p2, @p3, @p4, @p5, @p6, @p7, @p8, @p9, @p10);' n6 a& v, u. K
[10:45:15 INF] Executed endpoint 'Hot Chocolate GraphQL Pipeline'' L$ ~: p) F" m1 q2 }
</code></pre>1 B" Q& N. {- Y
<p>可以看到新建的Post已经存储到数据库中了,我们可以通过查询接口来获取详情:</p>+ [) M. r, i/ H8 Q$ d
<p><img src="https://img2022.cnblogs.com/blog/2487237/202202/2487237-20220211104851825-1533915064.png" ></p>) g. K7 L& R' I# K- i2 q
<h2 id="总结">总结</h2>
7 a/ t3 M5 t' H0 S<p>在本文中我们实现了简单的新增Post操作,这里还有一些涉及到错误处理的内容,我没有在文章中演示,可以参考官方文档 <a href="https://chillicream.com/docs/hotchocolate/defining-a-schema/mutations/#errors">Errors</a>,在自定义异常对象后,有三种方式可以进行错误处理:直接返回异常;使用异常工厂方法;使用构造函数。甚至可以在<code>AggregateExceptions</code>中一次性返回多个异常。基本思路都是通过添加属性<code>[Error(typeof(SomeUserDefinedException))]</code>来实现的。</p>
4 V' B# d) ]5 z* k8 U; w4 {<p>在下一篇文章中,我们通过<code>Mutation</code>对已有数据进行更新。</p>
, P9 y+ u: Q8 e$ b
! d- o" T Y& z/ J0 ~+ Q |
|