RestSharp实战:5分钟搞定微信支付与天气API调用(C#保姆级教程)
当我们需要快速集成第三方API时,一个高效、简洁的HTTP客户端库能大幅提升开发效率。RestSharp作为.NET生态中广受欢迎的轻量级解决方案,以其直观的API设计和跨平台特性,成为中小型项目对接外部服务的首选工具。本文将手把手带你用RestSharp完成两个高频场景——微信支付下单与和风天气查询,从环境配置到异常处理,每个步骤都配有可落地的代码示例。
1. 环境准备与基础配置
在开始调用具体API前,我们需要完成RestSharp的基础环境搭建。与官方文档的通用示例不同,这里会针对实际开发中的常见需求进行优化配置。
首先通过NuGet安装最新版RestSharp(当前稳定版本为110.2.0):
dotnet add package RestSharp建议同时安装Newtonsoft.Json以处理复杂的JSON数据:
dotnet add package Newtonsoft.Json基础客户端配置建议采用单例模式,避免重复创建连接消耗资源。下面是一个增强版的客户端工厂实现:
public static class RestClientFactory { private static readonly ConcurrentDictionary<string, RestClient> _clients = new(); public static RestClient GetClient(string baseUrl) { return _clients.GetOrAdd(baseUrl, url => { var options = new RestClientOptions(url) { ThrowOnAnyError = false, Timeout = 3000, UserAgent = "MyApp/1.0" }; var client = new RestClient(options); client.AddDefaultHeader("Accept", "application/json"); return client; }); } }提示:实际项目中建议将超时时间调整为5-10秒,并根据API特性配置重试策略
2. 微信支付接口集成实战
微信支付V3接口要求使用HTTPS协议和特定的认证方式,这对HTTP客户端提出了更高要求。下面我们实现完整的下单流程。
2.1 构建签名与认证头
微信支付需要对请求进行签名验证,这是最容易出错的环节。以下是经过验证的签名生成方法:
public string GenerateWeChatPaySignature( string method, string url, string body, string merchantId, string privateKey) { var timestamp = DateTimeOffset.Now.ToUnixTimeSeconds().ToString(); var nonceStr = Guid.NewGuid().ToString("N"); var signatureData = $"{method}\n{url}\n{timestamp}\n{nonceStr}\n{body}\n"; using var rsa = RSA.Create(); rsa.ImportFromPem(privateKey); var signatureBytes = rsa.SignData( Encoding.UTF8.GetBytes(signatureData), HashAlgorithmName.SHA256, RSASignaturePadding.Pkcs1); return Convert.ToBase64String(signatureBytes); }2.2 完整支付请求示例
结合签名方法,下面是调用JSAPI下单接口的完整实现:
public async Task<WeChatPayResponse> CreatePaymentOrder(WeChatPayRequest request) { var client = RestClientFactory.GetClient("https://api.mch.weixin.qq.com"); var endpoint = "/v3/pay/transactions/jsapi"; var body = JsonConvert.SerializeObject(request); var signature = GenerateWeChatPaySignature( "POST", endpoint, body, _config.MerchantId, _config.PrivateKey); var restRequest = new RestRequest(endpoint, Method.Post) .AddHeader("Authorization", $"WECHATPAY2-SHA256-RSA2048 {signature}") .AddHeader("Wechatpay-Serial", _config.CertSerialNo) .AddJsonBody(body); var response = await client.ExecuteAsync<WeChatPayResponse>(restRequest); if (!response.IsSuccessful) { throw new WeChatPayException( $"支付请求失败: {response.StatusCode}", response.ErrorException); } return response.Data; }常见问题处理:
- 签名失败:检查私钥格式是否正确(需PKCS#8格式)
- 证书序列号错误:确认商户平台配置的证书序列号
- 时间戳偏差:确保服务器时间与北京时间同步
3. 和风天气API集成指南
天气数据接口通常需要处理地理位置编码和复杂的气象数据解析。和风天气的免费版API足以满足大多数场景需求。
3.1 地理位置编码处理
首先需要将城市名称转换为LocationID:
public async Task<string> GetLocationId(string cityName) { var client = RestClientFactory.GetClient("https://geoapi.qweather.com"); var request = new RestRequest("/v2/city/lookup") .AddParameter("location", cityName) .AddParameter("key", _config.WeatherApiKey); var response = await client.GetAsync<LocationResponse>(request); return response?.Locations?.FirstOrDefault()?.Id ?? throw new WeatherException("未找到指定城市"); }3.2 实时天气数据获取
获取到LocationID后,可以查询实时天气:
public async Task<WeatherData> GetCurrentWeather(string locationId) { var client = RestClientFactory.GetClient("https://api.qweather.com"); var request = new RestRequest("/v7/weather/now") .AddParameter("location", locationId) .AddParameter("key", _config.WeatherApiKey); var response = await client.GetAsync<WeatherResponse>(request); if (response?.Now == null) { throw new WeatherException("天气数据解析失败"); } return new WeatherData { Temperature = response.Now.Temp, Condition = response.Now.Text, WindSpeed = response.Now.WindSpeed, Humidity = response.Now.Humidity, UpdateTime = response.UpdateTime }; }注意:和风天气免费版有每分钟100次的调用限制,生产环境建议添加缓存层
4. 高级技巧与性能优化
当项目需要频繁调用API时,以下几个优化策略可以显著提升稳定性和性能。
4.1 智能重试机制
针对网络波动导致的失败,实现带退避策略的重试:
public async Task<T> ExecuteWithRetry<T>( RestRequest request, int maxRetries = 3) { var client = request.Client; Exception lastError = null; for (int i = 0; i < maxRetries; i++) { try { var response = await client.ExecuteAsync<T>(request); if (response.IsSuccessful) { return response.Data; } if ((int)response.StatusCode >= 500) { throw new HttpRequestException($"服务端错误: {response.StatusCode}"); } } catch (Exception ex) { lastError = ex; if (i < maxRetries - 1) { var delay = (int)Math.Pow(2, i) * 100; await Task.Delay(delay + Random.Shared.Next(0, 100)); } } } throw new ApiIntegrationException("API调用失败", lastError); }4.2 响应缓存策略
对天气这类变化不频繁的数据,添加内存缓存:
public class WeatherServiceWithCache : IWeatherService { private readonly MemoryCache _cache = new(new MemoryCacheOptions { SizeLimit = 1000 }); public async Task<WeatherData> GetCurrentWeather(string cityName) { var cacheKey = $"weather_{cityName}"; if (_cache.TryGetValue(cacheKey, out WeatherData cachedData)) { return cachedData; } var locationId = await GetLocationId(cityName); var liveData = await GetCurrentWeather(locationId); _cache.Set(cacheKey, liveData, new MemoryCacheEntryOptions { AbsoluteExpirationRelativeToNow = TimeSpan.FromMinutes(10), Size = 1 }); return liveData; } }4.3 请求日志与监控
添加HTTP请求日志中间件,便于问题排查:
public class LoggingHttpInterceptor : HttpInterceptor { private readonly ILogger _logger; public override async Task<RestResponse> ExecuteAsync( RestRequest request, CancellationToken cancellationToken) { var stopwatch = Stopwatch.StartNew(); try { _logger.LogInformation( "开始请求 {Method} {Resource}", request.Method, request.Resource); var response = await base.ExecuteAsync(request, cancellationToken); _logger.LogInformation( "请求完成 {StatusCode} 耗时 {Elapsed}ms", response.StatusCode, stopwatch.ElapsedMilliseconds); return response; } catch (Exception ex) { _logger.LogError(ex, "请求异常"); throw; } } }在项目中使用时,只需在客户端配置中添加拦截器:
var client = new RestClient(options) .UseInterceptor(new LoggingHttpInterceptor(logger));