• RestSharp使用


    RestSharp

    应该是 .Net 目前最流行的Restful Api 客户端
    官方文档

    安装

    dotnet add package RestSharp
    
    • 1

    或者 NuGet搜索 RestSharp

    快速入门

    var client = new RestClient();
    // client.AddDefaultParameter("foo", "bar"); 这样每个请求都自带这个参数 client.AddDefaultQueryParameter("foo", "bar");
    var request = new RestRequest(new Uri("url?key1=value1&key2=value2"), RestSharp.Method.Get);
    request.AddHeader("Content-Type", "application/json");
    // 如果是QueryParams 参数直接拼接在url中即可
    // request.AddBody(请求体对象); // 这样用在Post 请求体  application/json
    // request.AddParameter("key", "value"); //这个一般用在 Post application/x-www-form-urlencoded,可以使用AddObject来代替AddParameter 把parameter包装在一个object里
    // request.AddUrlSegment("id","123") 可以对url中的占位符进行赋值 url = /api/User/{id}
    // request.AddCookie("foo", "bar"); 添加cookie
    // request.AddFile 添加文件
    // request.AddFile("File", "/C:/Users/HLT/Downloads/wind.png");
    //request.AddFile("File", "/C:/Users/HLT/Downloads/凤凰传奇 - 全是爱.flac");
    var response = await client.ExecuteAsync(request);
    if (response.StatusCode == System.Net.HttpStatusCode.OK)
    	string result = response.Content;
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15

    上传文件:参数名称,文件路径/字节数组/等,

    // Adds a file from disk
    AddFile(parameterName, filePath, contentType);
    
    // Adds an array of bytes
    AddFile(parameterName, bytes, fileName, contentType);
    
    // Adds a stream returned by the getFile function
    AddFile(parameterName, getFile, fileName, contentType);
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8

    封装一下

    // 请求包装类
    public class BaseRequest
    {
        public Method Method { get; set; }
        public string Route { get; set; }
        public string ContentType { get; set; } = "application/json";
        public object Parameter { get; set; }
    }
    
    // 请求类
    public class HttpRestClient
    {
        private readonly string apiUrl;
    
        protected readonly RestClient client;
    
    
        public HttpRestClient(string apiUrl)
        {
            this.apiUrl = apiUrl;
            client = new RestClient();
        }
    
    
        public async Task<ApiResponse> ExecuteAsync(BaseRequest baseRequest)
        {
            var request = new RestRequest(new Uri(apiUrl + baseRequest.Route), baseRequest.Method);
            request.AddHeader("Content-Type", baseRequest.ContentType);
    
            if (baseRequest.Parameter != null)
                //request.AddParameter("param", JsonConvert.SerializeObject(baseRequest.Parameter), ParameterType.RequestBody);
                request.AddBody(baseRequest.Parameter);
            var response = await client.ExecuteAsync(request);
            if (response.StatusCode == System.Net.HttpStatusCode.OK)
                return JsonConvert.DeserializeObject<ApiResponse>(response.Content);
    
            else
                return new ApiResponse()
                {
                    Status = false,
                    Result = null,
                    Message = response.ErrorMessage
                };
        }
    
        public async Task<ApiResponse<T>> ExecuteAsync<T>(BaseRequest baseRequest)
        {
            var request = new RestRequest(new Uri(apiUrl + baseRequest.Route), baseRequest.Method);
            request.AddHeader("Content-Type", baseRequest.ContentType);
    
            if (baseRequest.Parameter != null)
                //request.AddParameter("param", JsonConvert.SerializeObject(baseRequest.Parameter), ParameterType.RequestBody);
                request.AddBody(baseRequest.Parameter);
            var response = await client.ExecuteAsync(request);
            if (response.StatusCode == System.Net.HttpStatusCode.OK)
                return JsonConvert.DeserializeObject<ApiResponse<T>>(response.Content);
    
            else
                return new ApiResponse<T>()
                {
                    Status = false,
                    Message = response.ErrorMessage
                };
        }
    }
    
    // 基础请求动作分装
    public interface IBaseService<TEntity> where TEntity : class
    {
        Task<ApiResponse<TEntity>> AddAsync(TEntity entity);
    
        Task<ApiResponse<TEntity>> UpdateAsync(TEntity entity);
    
        Task<ApiResponse> DeleteAsync(int id);
    
        Task<ApiResponse<TEntity>> GetFirstOfDefaultAsync(int id);
    
        Task<ApiResponse<PagedList<TEntity>>> GetAllAsync(QueryParameter parameter);
    }
    
    // 基本请求动作分装实现
    public class BaseService<TEntity> : IBaseService<TEntity> where TEntity : class
    {
    
        private readonly HttpRestClient client;
        private readonly string serviceName;
    
        public BaseService(HttpRestClient client, string serviceName)
        {
            this.client = client;
            this.serviceName = serviceName;
        }
    
        public async Task<ApiResponse<TEntity>> AddAsync(TEntity entity)
        {
            BaseRequest request = new BaseRequest();
            request.Method = RestSharp.Method.Post;
            request.Route = $"api/{serviceName}/Add";
            request.Parameter = entity;
            return await client.ExecuteAsync<TEntity>(request);
        }
    
        public async Task<ApiResponse> DeleteAsync(int id)
        {
            BaseRequest request = new BaseRequest();
            request.Method = RestSharp.Method.Delete;
            request.Route = $"api/{serviceName}/Delete?id={id}";
            return await client.ExecuteAsync(request);
        }
    
        public async Task<ApiResponse<PagedList<TEntity>>> GetAllAsync(QueryParameter parameter)
        {
            BaseRequest request = new BaseRequest();
            request.Method = RestSharp.Method.Get;
            request.Route = $"api/{serviceName}/GetAll?pageIndex={parameter.PageIndex}" +
                $"&pageSize={parameter.PageSize}" +
                $"&search={parameter.Search}";
            return await client.ExecuteAsync<PagedList<TEntity>>(request);
        }
    
        public async Task<ApiResponse<TEntity>> GetFirstOfDefaultAsync(int id)
        {
            BaseRequest request = new BaseRequest();
            request.Method = RestSharp.Method.Get;
            request.Route = $"api/{serviceName}/Get?id={id}";
            return await client.ExecuteAsync<TEntity>(request);
        }
    
        public async Task<ApiResponse<TEntity>> UpdateAsync(TEntity entity)
        {
            BaseRequest request = new BaseRequest();
            request.Method = RestSharp.Method.Post;
            request.Route = $"api/{serviceName}/Update";
            request.Parameter = entity;
            return await client.ExecuteAsync<TEntity>(request);
        }
    }
    
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42
    • 43
    • 44
    • 45
    • 46
    • 47
    • 48
    • 49
    • 50
    • 51
    • 52
    • 53
    • 54
    • 55
    • 56
    • 57
    • 58
    • 59
    • 60
    • 61
    • 62
    • 63
    • 64
    • 65
    • 66
    • 67
    • 68
    • 69
    • 70
    • 71
    • 72
    • 73
    • 74
    • 75
    • 76
    • 77
    • 78
    • 79
    • 80
    • 81
    • 82
    • 83
    • 84
    • 85
    • 86
    • 87
    • 88
    • 89
    • 90
    • 91
    • 92
    • 93
    • 94
    • 95
    • 96
    • 97
    • 98
    • 99
    • 100
    • 101
    • 102
    • 103
    • 104
    • 105
    • 106
    • 107
    • 108
    • 109
    • 110
    • 111
    • 112
    • 113
    • 114
    • 115
    • 116
    • 117
    • 118
    • 119
    • 120
    • 121
    • 122
    • 123
    • 124
    • 125
    • 126
    • 127
    • 128
    • 129
    • 130
    • 131
    • 132
    • 133
    • 134
    • 135
    • 136
    • 137
    • 138

    在以上这几个类的基础上,我们只需要创建一个实例继承IBaseService和BaseService即可

    public interface IToDoService:IBaseService<ToDoDto>
    {
    	// 额外的接口
        public Task<ApiResponse<PagedList<ToDoDto>>> GetAllFilterAsync(ToDoParameter param);
    }
    
    // 真正我们使用的类
    public class ToDoService : BaseService<ToDoDto>, IToDoService
    {
        public ToDoService(HttpRestClient client) : base(client, "ToDo")
        {
            this.client = client;
        }
    
        private readonly HttpRestClient client;
    
        public async Task<ApiResponse<PagedList<ToDoDto>>> GetAllFilterAsync(ToDoParameter param)
        {
            BaseRequest request = new BaseRequest();
            request.Method = RestSharp.Method.Get;
            request.Route = $"api/ToDo/GetAll?pageIndex={param.PageIndex}" +
                $"&pageSize={param.PageSize}" +
                $"&search={param.Search}" +
                $"&Status={param.Status}";
            return await client.ExecuteAsync<PagedList<ToDoDto>>(request);
        }
    }
    
    
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29

    在.Net WPF Prism框架下使用

    
    public partial class App
    {
        protected override Window CreateShell()
        {
            return Container.Resolve<MainWindow>();
        }
    
        protected override void RegisterTypes(IContainerRegistry containerRegistry)
        {
            // 注册一个服务key 为 webUrl  为它创建实例传入构造参数
            containerRegistry.GetContainer().Register<HttpRestClient>(made: Parameters.Of.Type<string>(serviceKey: "webUrl"));
            containerRegistry.GetContainer().RegisterInstance(@"http://localhost:3333/", serviceKey: "webUrl");
    
    
            containerRegistry.Register<IToDoService, ToDoService>();
    
    
    
            containerRegistry.RegisterForNavigation<IndexView, IndexViewModel>();
            containerRegistry.RegisterForNavigation<TodoView, TodoViewModel>();
            containerRegistry.RegisterForNavigation<MemoView, MemoViewModel>();
            containerRegistry.RegisterForNavigation<SettingsView, SettingsViewModel>();
            containerRegistry.RegisterForNavigation<SkinView, SkinViewModel>();
            containerRegistry.RegisterForNavigation<AbortView>();
    
            
        }
    }
    
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30

    重点在
    将前面的 HttpRestClient 需要的构造函数进行注入,这样才可以将HttpRestClient 加入到 IOC容器中

    // 注册一个服务key 为 webUrl  为它创建实例传入构造参数
    containerRegistry.GetContainer().Register<HttpRestClient>(made: Parameters.Of.Type<string>(serviceKey: "webUrl"));
    containerRegistry.GetContainer().RegisterInstance(@"http://localhost:3333/", serviceKey: "webUrl");
    
    
    • 1
    • 2
    • 3
    • 4
  • 相关阅读:
    辅助知识-第7 章 知识产权与标准规范
    Go语学习笔记 - gorm使用 - 数据库配置、表新增 Web框架Gin(七)
    Blazor前后端框架Known-V1.2.12
    7、MySQL——聚合函数、分组查询、HAVING和WHERE子句的区别、LIMIT、分页查询
    学无止境,资深架构师—到底是如何阅读JDK源码的?
    【数据聚类】基于Baysian、KNN、3Layer Neural Network Classifier、KMeans多种算法实现数据聚类附matlab代码
    【云原生】创建harbor私有仓库及使用aliyun个人仓库
    关于如何重燃学习的激情
    性能测试-JMeter分布式测试及其详细步骤
    WPF动画小知识
  • 原文地址:https://blog.csdn.net/xiuyuandashen/article/details/133314271