.net core grpc json转码 swagger automapper grpc 可空类型 grpc empty 空值 实现CRUD (一)
参考 ASP.NET Core gRPC 应用中的 gRPC JSON 转码 | Microsoft Learn
为 gRPC JSON 转码 ASP.NET Core 应用配置 HTTP 和 JSON | Microsoft Learn
将 OpenAPI 与 gRPC JSON 转码 ASP.NET Core 应用配合使用 | Microsoft Learn
新建 grpc 服务项目
项目文件新增 节点 用于 xml 文档生成
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<NoWarn>$(NoWarn);1591</NoWarn>
项目引用 json转码
<PackageReference Include="Microsoft.AspNetCore.Grpc.JsonTranscoding" Version="8.0.3" />
引用swagger组件
<PackageReference Include="Swashbuckle.AspNetCore.Swagger" Version="6.5.0" />
<PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="6.5.0" />
引用grpc swagger组件
<PackageReference Include="Microsoft.AspNetCore.Grpc.Swagger" Version="0.8.3" />
引用 .net core ef 内存数据库用做测试
<PackageReference Include="Microsoft.EntityFrameworkCore.InMemory" Version="8.0.3" />
引用 automapper
<PackageReference Include="AutoMapper.Extensions.Microsoft.DependencyInjection" Version="12.0.1" />
完整项目文件
<Project Sdk="Microsoft.NET.Sdk.Web">
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<NoWarn>$(NoWarn);1591</NoWarn>
</PropertyGroup>
<ItemGroup>
<None Remove="Protos\grpcwebapi.proto" />
</ItemGroup>
<ItemGroup>
<Protobuf Include="Protos\example.proto" GrpcServices="Server" />
<Protobuf Include="Protos\grpcwebapi.proto" GrpcServices="Server" />
<Protobuf Include="Protos\grpcweb.proto" GrpcServices="Server" />
<Protobuf Include="Protos\greet.proto" GrpcServices="Server" />
</ItemGroup>
<ItemGroup>
<PackageReference Include="AutoMapper.Extensions.Microsoft.DependencyInjection" Version="12.0.1" />
<PackageReference Include="Grpc.AspNetCore" Version="2.57.0" />
<PackageReference Include="Grpc.AspNetCore.Web" Version="2.61.0" />
<PackageReference Include="Microsoft.AspNetCore.Grpc.JsonTranscoding" Version="8.0.3" />
<PackageReference Include="Microsoft.AspNetCore.Grpc.Swagger" Version="0.8.3" />
<PackageReference Include="Microsoft.EntityFrameworkCore.InMemory" Version="8.0.3" />
<PackageReference Include="Swashbuckle.AspNetCore.Swagger" Version="6.5.0" />
<PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="6.5.0" />
</ItemGroup>
</Project>
github 下载 grpc json proto支持文件
google/api/http.proto 文件链接
// Copyright 2019 Google LLC.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
syntax = "proto3";
package google.api;
option cc_enable_arenas = true;
option go_package = "google.golang.org/genproto/googleapis/api/annotations;annotations";
option java_multiple_files = true;
option java_outer_classname = "HttpProto";
option java_package = "com.google.api";
option objc_class_prefix = "GAPI";
// Defines the HTTP configuration for an API service. It contains a list of
// [HttpRule][google.api.HttpRule], each specifying the mapping of an RPC method
// to one or more HTTP REST API methods.
message Http {
// A list of HTTP configuration rules that apply to individual API methods.
//
// **NOTE:** All service configuration rules follow "last one wins" order.
repeated HttpRule rules = 1;
// When set to true, URL path parameters will be fully URI-decoded except in
// cases of single segment matches in reserved expansion, where "%2F" will be
// left encoded.
//
// The default behavior is to not decode RFC 6570 reserved characters in multi
// segment matches.
bool fully_decode_reserved_expansion = 2;
}
// # gRPC Transcoding
//
// gRPC Transcoding is a feature for mapping between a gRPC method and one or
// more HTTP REST endpoints. It allows developers to build a single API service
// that supports both gRPC APIs and REST APIs. Many systems, including [Google
// APIs](https://github.com/googleapis/googleapis),
// [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC
// Gateway](https://github.com/grpc-ecosystem/grpc-gateway),
// and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature
// and use it for large scale production services.
//
// `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies
// how different portions of the gRPC request message are mapped to the URL
// path, URL query parameters, and HTTP request body. It also controls how the
// gRPC response message is mapped to the HTTP response body. `HttpRule` is
// typically specified as an `google.api.http` annotation on the gRPC method.
//
// Each mapping specifies a URL path template and an HTTP method. The path
// template may refer to one or more fields in the gRPC request message, as long
// as each field is a non-repeated field with a primitive (non-message) type.
// The path template controls how fields of the request message are mapped to
// the URL path.
//
// Example:
//
// service Messaging {
// rpc GetMessage(GetMessageRequest) returns (Message) {
// option (google.api.http) = {
// get: "/v1/{name=messages/*}"
// };
// }
// }
// message GetMessageRequest {
// string name = 1; // Mapped to URL path.
// }
// message Message {
// string text = 1; // The resource content.
// }
//
// This enables an HTTP REST to gRPC mapping as below:
//
// HTTP | gRPC
// -----|-----
// `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")`
//
// Any fields in the request message which are not bound by the path template
// automatically become HTTP query parameters if there is no HTTP request body.
// For example:
//
// service Messaging {
// rpc GetMessage(GetMessageRequest) returns (Message) {
// option (google.api.http) = {
// get:"/v1/messages/{message_id}"
// };
// }
// }
// message GetMessageRequest {
// message SubMessage {
// string subfield = 1;
// }
// string message_id = 1; // Mapped to URL path.
// int64 revision = 2; // Mapped to URL query parameter `revision`.
// SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`.
// }
//
// This enables a HTTP JSON to RPC mapping as below:
//
// HTTP | gRPC
// -----|-----
// `GET /v1/messages/123456?revision=2&sub.subfield=foo` |
// `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield:
// "foo"))`
//
// Note that fields which are mapped to URL query parameters must have a
// primitive type or a repeated primitive type or a non-repeated message type.
// In the case of a repeated type, the parameter can be repeated in the URL
// as `...?param=A¶m=B`. In the case of a message type, each field of the
// message is mapped to a separate parameter, such as
// `...?foo.a=A&foo.b=B&foo.c=C`.
//
// For HTTP methods that allow a request body, the `body` field
// specifies the mapping. Consider a REST update method on the
// message resource collection:
//
// service Messaging {
// rpc UpdateMessage(UpdateMessageRequest) returns (Message) {
// option (google.api.http) = {
// patch: "/v1/messages/{message_id}"
// body: "message"
// };
// }
// }
// message UpdateMessageRequest {
// string message_id = 1; // mapped to the URL
// Message message = 2; // mapped to the body
// }
//
// The following HTTP JSON to RPC mapping is enabled, where the
// representation of the JSON in the request body is determined by
// protos JSON encoding:
//
// HTTP | gRPC
// -----|-----
// `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:
// "123456" message { text: "Hi!" })`
//
// The special name `*` can be used in the body mapping to define that
// every field not bound by the path template should be mapped to the
// request body. This enables the following alternative definition of
// the update method:
//
// service Messaging {
// rpc UpdateMessage(Message) returns (Message) {
// option (google.api.http) = {
// patch: "/v1/messages/{message_id}"
// body: "*"
// };
// }
// }
// message Message {
// string message_id = 1;
// string text = 2;
// }
//
//
// The following HTTP JSON to RPC mapping is enabled:
//
// HTTP | gRPC
// -----|-----
// `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:
// "123456" text: "Hi!")`
//
// Note that when using `*` in the body mapping, it is not possible to
// have HTTP parameters, as all fields not bound by the path end in
// the body. This makes this option more rarely used in practice when
// defining REST APIs. The common usage of `*` is in custom methods
// which don't use the URL at all for transferring data.
//
// It is possible to define multiple HTTP methods for one RPC by using
// the `additional_bindings` option. Example:
//
// service Messaging {
// rpc GetMessage(GetMessageRequest) returns (Message) {
// option (google.api.http) = {
// get: "/v1/messages/{message_id}"
// additional_bindings {
// get: "/v1/users/{user_id}/messages/{message_id}"
// }
// };
// }
// }
// message GetMessageRequest {
// string message_id = 1;
// string user_id = 2;
// }
//
// This enables the following two alternative HTTP JSON to RPC mappings:
//
// HTTP | gRPC
// -----|-----
// `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`
// `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id:
// "123456")`
//
// ## Rules for HTTP mapping
//
// 1. Leaf request fields (recursive expansion nested messages in the request
// message) are classified into three categories:
// - Fields referred by the path template. They are passed via the URL path.
// - Fields referred by the [HttpRule.body][google.api.HttpRule.body]. They are passed via the HTTP
// request body.
// - All other fields are passed via the URL query parameters, and the
// parameter name is the field path in the request message. A repeated
// field can be represented as multiple query parameters under the same
// name.
// 2. If [HttpRule.body][google.api.HttpRule.body] is "*", there is no URL query parameter, all fields
// are passed via URL path and HTTP request body.
// 3. If [HttpRule.body][google.api.HttpRule.body] is omitted, there is no HTTP request body, all
// fields are passed via URL path and URL query parameters.
//
// ### Path template syntax
//
// Template = "/" Segments [ Verb ] ;
// Segments = Segment { "/" Segment } ;
// Segment = "*" | "**" | LITERAL | Variable ;
// Variable = "{" FieldPath [ "=" Segments ] "}" ;
// FieldPath = IDENT { "." IDENT } ;
// Verb = ":" LITERAL ;
//
// The syntax `*` matches a single URL path segment. The syntax `**` matches
// zero or more URL path segments, which must be the last part of the URL path
// except the `Verb`.
//
// The syntax `Variable` matches part of the URL path as specified by its
// template. A variable template must not contain other variables. If a variable
// matches a single path segment, its template may be omitted, e.g. `{var}`
// is equivalent to `{var=*}`.
//
// The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL`
// contains any reserved character, such characters should be percent-encoded
// before the matching.
//
// If a variable contains exactly one path segment, such as `"{var}"` or
// `"{var=*}"`, when such a variable is expanded into a URL path on the client
// side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The
// server side does the reverse decoding. Such variables show up in the
// [Discovery
// Document](https://developers.google.com/discovery/v1/reference/apis) as
// `{var}`.
//
// If a variable contains multiple path segments, such as `"{var=foo/*}"`
// or `"{var=**}"`, when such a variable is expanded into a URL path on the
// client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded.
// The server side does the reverse decoding, except "%2F" and "%2f" are left
// unchanged. Such variables show up in the
// [Discovery
// Document](https://developers.google.com/discovery/v1/reference/apis) as
// `{+var}`.
//
// ## Using gRPC API Service Configuration
//
// gRPC API Service Configuration (service config) is a configuration language
// for configuring a gRPC service to become a user-facing product. The
// service config is simply the YAML representation of the `google.api.Service`
// proto message.
//
// As an alternative to annotating your proto file, you can configure gRPC
// transcoding in your service config YAML files. You do this by specifying a
// `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same
// effect as the proto annotation. This can be particularly useful if you
// have a proto that is reused in multiple services. Note that any transcoding
// specified in the service config will override any matching transcoding
// configuration in the proto.
//
// Example:
//
// http:
// rules:
// # Selects a gRPC method and applies HttpRule to it.
// - selector: example.v1.Messaging.GetMessage
// get: /v1/messages/{message_id}/{sub.subfield}
//
// ## Special notes
//
// When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the
// proto to JSON conversion must follow the [proto3
// specification](https://developers.google.com/protocol-buffers/docs/proto3#json).
//
// While the single segment variable follows the semantics of
// [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
// Expansion, the multi segment variable **does not** follow RFC 6570 Section
// 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion
// does not expand special characters like `?` and `#`, which would lead
// to invalid URLs. As the result, gRPC Transcoding uses a custom encoding
// for multi segment variables.
//
// The path variables **must not** refer to any repeated or mapped field,
// because client libraries are not capable of handling such variable expansion.
//
// The path variables **must not** capture the leading "/" character. The reason
// is that the most common use case "{var}" does not capture the leading "/"
// character. For consistency, all path variables must share the same behavior.
//
// Repeated message fields must not be mapped to URL query parameters, because
// no client library can support such complicated mapping.
//
// If an API needs to use a JSON array for request or response body, it can map
// the request or response body to a repeated field. However, some gRPC
// Transcoding implementations may not support this feature.
message HttpRule {
// Selects a method to which this rule applies.
//
// Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
string selector = 1;
// Determines the URL pattern is matched by this rules. This pattern can be
// used with any of the {get|put|post|delete|patch} methods. A custom method
// can be defined using the 'custom' field.
oneof pattern {
// Maps to HTTP GET. Used for listing and getting information about
// resources.
string get = 2;
// Maps to HTTP PUT. Used for replacing a resource.
string put = 3;
// Maps to HTTP POST. Used for creating a resource or performing an action.
string post = 4;
// Maps to HTTP DELETE. Used for deleting a resource.
string delete = 5;
// Maps to HTTP PATCH. Used for updating a resource.
string patch = 6;
// The custom pattern is used for specifying an HTTP method that is not
// included in the `pattern` field, such as HEAD, or "*" to leave the
// HTTP method unspecified for this rule. The wild-card rule is useful
// for services that provide content to Web (HTML) clients.
CustomHttpPattern custom = 8;
}
// The name of the request field whose value is mapped to the HTTP request
// body, or `*` for mapping all request fields not captured by the path
// pattern to the HTTP body, or omitted for not having any HTTP request body.
//
// NOTE: the referred field must be present at the top-level of the request
// message type.
string body = 7;
// Optional. The name of the response field whose value is mapped to the HTTP
// response body. When omitted, the entire response message will be used
// as the HTTP response body.
//
// NOTE: The referred field must be present at the top-level of the response
// message type.
string response_body = 12;
// Additional HTTP bindings for the selector. Nested bindings must
// not contain an `additional_bindings` field themselves (that is,
// the nesting may only be one level deep).
repeated HttpRule additional_bindings = 11;
}
// A custom pattern is used for defining custom HTTP verb.
message CustomHttpPattern {
// The name of this custom HTTP verb.
string kind = 1;
// The path matched by this custom verb.
string path = 2;
}
google/api/annotations.proto 文件链接
// Copyright (c) 2015, Google Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";
package google.api;
import "google/api/http.proto";
import "google/protobuf/descriptor.proto";
option go_package = "google.golang.org/genproto/googleapis/api/annotations;annotations";
option java_multiple_files = true;
option java_outer_classname = "AnnotationsProto";
option java_package = "com.google.api";
option objc_class_prefix = "GAPI";
extend google.protobuf.MethodOptions {
// See `HttpRule`.
HttpRule http = 72295728;
}
以下是配置依赖注入 和 配置中间件
using GrpcService1.data;
using GrpcService1.Services;
using Microsoft.AspNetCore.Cors.Infrastructure;
using Microsoft.EntityFrameworkCore;
using System.Reflection;
var builder = WebApplication.CreateBuilder(args);
// Add services to the container.
//添加 json 转码 AddJsonTranscoding
builder.Services.AddGrpc().AddJsonTranscoding();
//builder.Services.AddCors(options =>
//{
// options.AddPolicy("GrpcPolicy", builder =>
// {
// builder.AllowAnyOrigin()
// .AllowAnyHeader()
// .AllowAnyMethod()
// .WithExposedHeaders("Grpc-Status", "Grpc-Message", "GrpcEncoding", "Grpc-Accept-Encoding");
// });
//});
//注入 automapper 加载当前程序集中的Profiles 映射配置文件
builder.Services.AddAutoMapper(Assembly.GetExecutingAssembly());
builder.Services.AddGrpcSwagger();
builder.Services.AddSwaggerGen(options =>
{
options.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo
{
Title = "grpc",
Description = "grpctest",
});
string assmablyName = Assembly.GetExecutingAssembly().GetName().Name;
string xmlPath = Path.Combine(AppContext.BaseDirectory, assmablyName + ".xml");
options.IncludeXmlComments(xmlPath);
//配置grpc xml文档
options.IncludeGrpcXmlComments(xmlPath, includeControllerXmlComments: true);
});
//配置 内存数据库
builder.Services.AddDbContext<MyDataContext>(options =>
{
options.UseInMemoryDatabase("testgrpc");
});
var app = builder.Build();
//播种
using (var scope = app.Services.CreateScope())
{
await SeedWork.Seed(scope.ServiceProvider);
}
app.UseSwagger();
app.UseSwaggerUI(options =>
{
options.SwaggerEndpoint("/swagger/v1/swagger.json", "GrpcTestSwagger");
});
//app.UseCors("GrpcPolicy");
//app.UseGrpcWeb();
//app.UseHttpsRedirection();
// Configure the HTTP request pipeline.
//app.MapGrpcService<GreeterService>().EnableGrpcWeb().RequireCors("GrpcPolicy");
app.MapGrpcService<GreeterService>();
app.MapGrpcService<ExampleServer>();
app.MapGrpcService<TestWebApiServer>();
//app.MapGrpcService<TestWebApiService>()
//app.MapGet("/", () => "Communication with gRPC endpoints must be made through a gRPC client. To learn how to create a client, visit: https://go.microsoft.com/fwlink/?linkid=2086909");
app.Run();
接下来 是 dbcontext 和 播种
MyDataContext
using GrpcService1.Models; using Microsoft.EntityFrameworkCore; namespace GrpcService1.data { /// <summary> /// dbcontext /// </summary> public class MyDataContext:DbContext { /// <summary> /// 构造函数 /// </summary> /// <param name="options"></param> public MyDataContext(DbContextOptions<MyDataContext> options):base(options) { } /// <summary> /// 用户 /// </summary> public DbSet<User> Users { get; set; } } }
SeedWork
using GrpcService1.Models;
using Microsoft.EntityFrameworkCore;
namespace GrpcService1.data
{
/// <summary>
/// 种子
/// </summary>
public class SeedWork
{
/// <summary>
/// 执行 播种
/// </summary>
/// <param name="provider"></param>
/// <returns></returns>
public static async Task Seed(IServiceProvider provider)
{
using var db = provider.GetRequiredService<MyDataContext>();
if (db == null || await db.Users.AnyAsync())
{
return;
}
List<User> users = new List<User>()
{
new User{ Id= 1, Name ="小李" },
new User{ Id= 2, Name ="小明" },
};
await db.Users.AddRangeAsync(users);
await db.SaveChangesAsync();
}
}
}
User
namespace GrpcService1.Models
{
/// <summary>
/// 用户
/// </summary>
public class User
{
/// <summary>
/// id
/// </summary>
public int Id { get; set; }
/// <summary>
/// 用户名
/// </summary>
public string Name { get; set; }
}
}
以下 是 proto文件
本文件 包含 grpc 可空类型 空值 json 转码
注意： json 转码 导入 import "google/api/annotations.proto";
空值 导入 import "google/protobuf/empty.proto";
使用 google.protobuf.Empty
可空类型导入 import "google/protobuf/wrappers.proto";
使用 google.protobuf.Int32Value id =1;
syntax = "proto3"; option csharp_namespace = "GrpcWebApiService1"; package testwebapi; import "google/api/annotations.proto"; import "google/protobuf/empty.proto"; import "google/protobuf/wrappers.proto"; // The TestWebApi service definition. service TestWebApi { // TestWebApi rpc SayHello (WebApiRequest) returns (WebApiReply){ option (google.api.http) = { get: "/v1/WebApi/{name}" }; }; //获取用户集合 //空值 google.protobuf.Empty rpc GetUsersAll(google.protobuf.Empty) returns(UsersReplay){ option (google.api.http) = { get: "/v1/WebApi/GetUsersAll" }; } //获取一个用户通过用户id //可空类型 id rpc GetUserById(UserByIdRequest) returns(UserReplay){ option (google.api.http) = { get: "/v1/WebApi/GetUserById/{id}" }; } //创建一个用户 rpc CreateUser(UserCreateRequest)returns(StutsCodeReplay){ option (google.api.http) = { post: "/v1/WebApi/CreateUser/user", body:"user" }; } //删除一个用户 //可空类型 id rpc DeleteUserById(UserByIdRequest)returns(StutsCodeReplay){ option (google.api.http) = { delete: "/v1/WebApi/DeleteUserById/{id}" }; } } // 获取一个用户通过用户id message UserByIdRequest{ google.protobuf.Int32Value id =1; //int32 id =1; } //获取一个用户通过用户id 返回一个用户 message UserReplay{ GrpcUser user =1; } //返回用户集合 message UsersReplay{ repeated GrpcUser users =1; } //创建一个用户 message UserCreateRequest{ GrpcUser user =1; } //返回状态码 message StutsCodeReplay{ int32 code =1; } // The request message containing the user's name. message WebApiRequest { string name = 1; } // The response message containing the greetings. message WebApiReply { string message = 1; } message GrpcUser{ int32 Id =1; string Name =2; }
以下是 实现
TestWebApiServer
空值 Empty request
可空类型 异常处理
if (request.Id == null)
{
throw new RpcException(new Status(statusCode: StatusCode.InvalidArgument, detail: "id 为空"));
}
using AutoMapper; using Google.Protobuf.WellKnownTypes; using Grpc.Core; using GrpcService1.data; using GrpcService1.Models; using GrpcWebApiService1; using Microsoft.EntityFrameworkCore; using System.Net; using System.Text; using System.Text.Json; using System.Text.Unicode; namespace GrpcService1.Services { /// <summary> /// TestWebApiServer /// </summary> public class TestWebApiServer : TestWebApi.TestWebApiBase { private readonly MyDataContext myDataContext; private readonly ILogger<TestWebApiServer> logger; private readonly IMapper mapper; /// <summary> /// 构造函数 /// </summary> /// <param name="myDataContext"></param> /// <param name="logger"></param> public TestWebApiServer(MyDataContext myDataContext, ILogger<TestWebApiServer> logger, IMapper mapper) { this.myDataContext = myDataContext; this.logger = logger; this.mapper = mapper; } /// <summary> /// SayHello /// </summary> /// <param name="request"></param> /// <param name="context"></param> /// <returns></returns> public override Task<WebApiReply> SayHello(WebApiRequest request, ServerCallContext context) { string name = request.Name; WebApiReply apiReply = new WebApiReply { Message = $"hello :{name}" }; return Task.FromResult(apiReply); } /// <summary> /// 获取所有用户 /// </summary> /// <param name="request"></param> /// <param name="context"></param> /// <returns></returns> public override async Task<UsersReplay> GetUsersAll(Empty request, ServerCallContext context) { var user = context.GetHttpContext().User; List<User> users = await myDataContext.Users.AsNoTracking().ToListAsync(); UsersReplay usersReplay = mapper.Map<UsersReplay>(users); this.logger.LogInformation($"获取所用用户," + $"{JsonSerializer.Serialize(usersReplay, new JsonSerializerOptions { Encoder = System.Text.Encodings.Web.JavaScriptEncoder.Create(UnicodeRanges.All) } )}"); return usersReplay; } /// <summary> /// 获取一个用户通过用户id /// </summary> /// <param name="request"></param> /// <param name="context"></param> /// <returns></returns> public override async Task<UserReplay> GetUserById(UserByIdRequest request, ServerCallContext context) { if (request.Id == null) { throw new RpcException(new Status(statusCode: StatusCode.InvalidArgument, detail: "id 为空")); } User user = await this.myDataContext.Users.FindAsync(request.Id); UserReplay userReplay = mapper.Map<UserReplay>(user); this.logger.LogInformation($"获取一个用户,用户id:{request.Id},{JsonSerializer.Serialize(userReplay, new JsonSerializerOptions { Encoder = System.Text.Encodings.Web.JavaScriptEncoder.Create(UnicodeRanges.All) })}"); return userReplay; } /// <summary> /// 创建一个用户 /// </summary> /// <param name="request"></param> /// <param name="context"></param> /// <returns></returns> public override async Task<StutsCodeReplay> CreateUser(UserCreateRequest request, ServerCallContext context) { User user = mapper.Map<User>(request); if (user == null) { return new StutsCodeReplay { Code = (int)HttpStatusCode.BadRequest }; } await this.myDataContext.Users.AddAsync(user); await this.myDataContext.SaveChangesAsync(); this.logger.LogInformation($"创建一个用户,{JsonSerializer.Serialize(request, new JsonSerializerOptions { Encoder = System.Text.Encodings.Web.JavaScriptEncoder.Create(UnicodeRanges.All) })}"); return new StutsCodeReplay { Code = (int)HttpStatusCode.Created }; } /// <summary> /// 删除一个用户通过用户id /// </summary> /// <param name="request"></param> /// <param name="context"></param> /// <returns></returns> public override async Task<StutsCodeReplay> DeleteUserById(UserByIdRequest request, ServerCallContext context) { if (request.Id == null) { throw new RpcException(new Status(statusCode: StatusCode.InvalidArgument, "id 为空")); } User user = await this.myDataContext.Users.FindAsync(request.Id); if (user == null) { return new StutsCodeReplay { Code = (int)HttpStatusCode.NotFound }; } this.myDataContext.Users.Remove(user); await this.myDataContext.SaveChangesAsync(); this.logger.LogInformation($"删除一个用户，用户id:{request.Id},{JsonSerializer.Serialize(request, new JsonSerializerOptions { Encoder = System.Text.Encodings.Web.JavaScriptEncoder.Create(UnicodeRanges.All) })}"); return new StutsCodeReplay { Code = (int)HttpStatusCode.OK }; } } }
以下是 automapper user 对象的映射文件内容
重点说明 有子对象情况需要先对子对象进行映射
using AutoMapper;
using GrpcService1.Models;
using GrpcWebApiService1;
namespace GrpcService1.Profiles
{
/// <summary>
/// AUTOMAPPER USER
/// </summary>
public class UserProfile : Profile
{
/// <summary>
/// 构造函数
/// </summary>
public UserProfile()
{
//有子对象情况需要先对子对象进行映射
//user 与 GrpcUser 映射
CreateMap<User, GrpcUser>().ReverseMap();
//List<User>集合 与 UsersReplay对象中的Users集合 映射 这里是对子对象集合映射
//用于查询所有User返回 List<User>
CreateMap<List<User>, UsersReplay>().ForMember(item => item.Users, p => p.MapFrom(t => t));
//User 对象 与 UserReplay 子对象 User 映射 用于返回一个User
CreateMap<User, UserReplay>().ForMember(item => item.User, p => p.MapFrom(t => t));
//User 对象 与 UserCreateRequest 子对象 User 映射 用于创建一个User对象
CreateMap<User, UserCreateRequest>().ForMember(item=>item.User, p => p.MapFrom(t => t)).ReverseMap();
}
}
}
launchSettings.json 文件修改
appsettings.json 文件
测试结果
测试GetUsersAll
测试 GetUserById/1
测试 创建
测试删除
查看 getall 剩余 数据
浙公网安备 33010602011771号