Introduction
ApiEn tant que fournisseur de logique métier, il porte la logique de base du projet, il a donc une complexité logique relativement élevée. Dans un tel principe, comment simplifier l'écriture du code, comment standardiser et unifier le style d'écriture et les spécifications logiques, et comment améliorer la maintenabilité et l'évolutivité du code. Il devient important de construire des projets à forte cohésion et à faible couplage.
L'exemple est un projet au niveau de l'entreprise. Le framework est comme indiqué ci-dessous
api layer.jpg
Sécurité : La requête Http (Override DelegatingHandler) est réécrite, la validité de la requête est jugée et les exigences de signature sont prétraitées.
Client : définit une méthode d'appel interface unifiée qui est utilisée par l'extrémité appelante, simplifiant et unifiant l'utilisation de l'interface.
Couche Ctrl : en tant que fournisseur direct de services, il fournit directement une interface similaire au style RestFul sur le serveur (il semble de style RestFul strict, nécessitant un domaine complet ModèlePilote , la situation réelle est toujours insatisfaisante et la capacité d'abstraction du domaine n'est pas suffisante), obtenez les données de la demande, appelez FilterFilter si nécessaire, portez un jugement plus approfondi et appelez
Model.Couche : en tant que couche de modèle économique, elle assure le fonctionnement réel de la logique métier. Utilisez un modèle d'entité unifié et connectez-le à Ibatis pour les opérations de données.
La structure spécifique du code est la suivante :
Api-UML.jpg
Ce qui suit est une introduction détaillée de chaque module et exemple de code :
Exemple de code de projet de bibliothèque d'entités
La structure du projet est la suivante :
entité. jpg
Domain module, en tant que modèle d'entité, le code simple est le suivant
public class User
{
public int Id { get; set; }
public string NickName { get; set; }
public string Avatar { get; set; }
}Copier après la connexion
Request, le modèle de structure de requête, utilise l'interface générique pour se connecter la classe de requête et la classe de retour, qui jouent un rôle Contrôler l'effet de l'inversion.
public abstract class AbstractRequest
{
public bool ValidateParameters()
{
//公用方法示例，验证参数合法性
}
}
public interface IRequest<T> where T:AbstractResponse
{
//获取接口名称
string GetApiName();
//获取接口编码
string GetApiCode();
}
//获取User信息的请求结构定义
public class GetUserRequest:AbstractRequest,IRequest<GetUserResponse>
{
public int Id { get; set; }
public string GetApiName()
{
return "User.GetUserDetail";
}
public string GetApiCode()
{
return "User001";
}
}Copier après la connexion
Le module de réponse, en tant que type de retour de la demande, définit une structure de retour unifiée pour permettre aux consommateurs de juger et de traiter la cohérence des codes de retour.
public abstract class AbstractResponse
{
//返回码
public int Code { get; set; }
//报错信息
public string Message { get; set; }
}
public class GetUserResponse:AbstractResponse
{
public User User { get; set; }
}Copier après la connexion
Exemple de code de projet de service
La structure du projet est la suivante :
service.jpg
Exemple de code :
public interface IUserService
{
GetUserResponse GetUser(int id);
}
public class BaseService
{
//protected SqlInstance sqlInstance;
public BaseService()
{
//sqlInstance=new SqlInstance(); //实例化数据库连接
//...
}
//...
}
public class UserService:BaseService,IUserService
{
public GetUserResponse GetUser(int id)
{
//链接数据库获取数据
//...
throw new NotImplementedException();
}
}Copier après la connexion
La bibliothèque de classes ne gère que le problème de Sécurité au niveau de l'entrée de la requête API Ajoutez un jugement d’autorisation. Utilisez la méthode de réécriture des requêtes Http.
Exemple de code
public class MyHandler : DelegatingHandler
{
protected async override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
{
IEnumerable<string> keyEnumerable;
var t1 = request.Headers.TryGetValues("key", out keyEnumerable);
var key = keyEnumerable.FirstOrDefault();
if (!true)//验证类似于token的权限
{
return await Task.Factory.StartNew<HttpResponseMessage>(
() => new HttpResponseMessage(HttpStatusCode.Forbidden)
{
Content = new StringContent("error message")
});
}
//如果有signature，判断，并加结果标志，没有的话，清除signature相关信息，防止伪造。
//.....
return await base.SendAsync(request, cancellationToken);
}
}Copier après la connexion
Le jugement d'autorisation abstrait peut être directement appelé à la fin de la webapi et ajouté au code de configuration routage.
Exemple de projet WebApi
En tant que définition réelle de l'interface, webapi définit les règles réelles du fichier d'interface et effectue la gestion de la sécurité et le contrôle des autorisations correspondants de l'interface . Pour apprendre le contrôle des autorisations de WeChat, plusieurs interfaces ont été grossièrement déterminées :
Interface permissions.png
Les jugements de ces les autorisations sont toutes placées. La gestion centralisée se fait dans la sécurité. La définition de l'interface ne doit être utilisée que pour juger de la légalité de la logique correspondante.
Exemple de code :
public class UserController : ApiController
{
private IUserService userService;
public UserController()
{
userService=new UserService();
}
[Signature]//安全签名过滤器判断
[HttpPost]
public GetUserResponse GetUser(GetUserRequest request)
{
//参数判断，安全性判断等等
var ret = userService.GetUser(request.Id);
return ret;
}
}Copier après la connexion
Ce qui précède est un exemple d'interface pour obtenir des informations utilisateur. En tant que configuration de routage de l'entrée de l'interface, vous devez juger de la légalité de la demande. comme suit :
public static void Register(HttpConfiguration config)
{
// Web API configuration and services
// Configure Web API to use only bearer token authentication.
config.SuppressDefaultHostAuthentication();
config.Filters.Add(new HostAuthenticationFilter(OAuthDefaults.AuthenticationType));
// Web API routes
config.MapHttpAttributeRoutes();
config.Routes.MapHttpRoute(
name: "DefaultApi",
routeTemplate: "api/{controller}/{action}",
defaults: new { id = RouteParameter.Optional }
);
//添加的代码，添加http请求的入口处理
config.MessageHandlers.Add(new MyHandler());
}Copier après la connexion
Exemple de code de bibliothèque de classes client
La bibliothèque de classes client définit les méthodes publiques appelées par l'interface.
1. Utilisez des interfaces génériques pour encapsuler la classe de requête et la classe de retour afin de simplifier l'écriture du code appelant.
2. Il permet également aux consommateurs d'appeler des interfaces via des classes proxy, évitant ainsi les problèmes inter-domaines.
3. Les appels des consommateurs acceptent tous d'utiliser une bibliothèque de classes unifiée, de sorte que le traitement des journaux soit unifié et que les erreurs renvoyées puissent également être définies de manière cohérente.
L'exemple de code est le suivant :
public interface IClient
{
T Execute<T>(IRequest<T> request) where T : AbstractResponse;
}
public class DefaultClient:IClient
{
private readonly string appKey;
private readonly string appSecret;
private readonly string baseUrl = "http://localhost:16469/api/";
private readonly bool isNeedLogFile = false;
private readonly LogFile logFile;
public static readonly string SecureHeaderAppKey = "secure_head_appkey";
public static readonly string SecureHeaderSignature = "secure_head_signature";
public DefaultClient()
{
baseUrl = ConfigurationManager.AppSettings["service_base_url"];
appKey = ConfigurationManager.AppSettings["app_key"];
appSecret = ConfigurationManager.AppSettings["app_secret"];
isNeedLogFile = "1".Equals(ConfigurationManager.AppSettings["client_log_file"]);
logFile = new LogFile("client_log_path");
logFile.SubPath = appKey;
}
public DefaultClient(string serviceBase, string code, string key)
{
baseUrl = serviceBase;
appKey = code;
appSecret = key;
}
public T Execute<T>(IRequest<T> request) where T : AbstractResponse
{
var webRequest = (HttpWebRequest)WebRequest.Create(baseUrl + request.GetApiName());
webRequest.Method = "POST";
string reqJson;
string sign;
using (Stream rs = webRequest.GetRequestStream())
{
reqJson = JsonConvert.SerializeObject(request);
byte[] reqBytes = Encoding.UTF8.GetBytes(reqJson);
rs.Write(reqBytes, 0, reqBytes.Length);
rs.Close();
}
webRequest.ContentType = "application/json";
webRequest.Headers.Add(SecureHeaderAppKey, appKey);
sign = ComputeHash(appKey, appSecret, reqJson);
webRequest.Headers.Add(SecureHeaderSignature, sign);
//记录日志
if (isNeedLogFile)
{
logFile.Log(string.Format("[{0}] 请求内容: {1}", request.GetApiCode(), reqJson));
logFile.Log(string.Format("[{0}] 请求签名: {1}", request.GetApiCode(), sign));
}
try
{
using (var resp = (HttpWebResponse)webRequest.GetResponse())
{
try
{
Stream respStream = resp.GetResponseStream();
if (respStream == null)
{
throw new WebException("GetResponseStream returned null");
}
var streamReader = new StreamReader(respStream);
string respStr = streamReader.ReadToEnd();
//记录日志
if (isNeedLogFile)
{
logFile.Log(string.Format("[{0}] 响应内容: {1}", request.GetApiCode(), respStr));
}
return JsonConvert.DeserializeObject<T>(respStr);
}
catch (Exception e)
{
//记录日志
if (isNeedLogFile)
{
logFile.Log(string.Format("[{0}] 响应错误: {1}", request.GetApiCode(), e.Message));
}
throw new ApplicationException(e.Message, e);
}
}
}
catch (WebException e)
{
var errMsg = new StreamReader(e.Response.GetResponseStream()).ReadToEnd();
//记录日志
if (isNeedLogFile)
{
logFile.Log(string.Format("[{0}] 请求错误: {1}", request.GetApiCode(), errMsg));
}
throw new APIServiceException(errMsg);
}
}
private string ComputeHash(string key, string secret, string body)
{
return
Convert.ToBase64String(
SHA1.Create().ComputeHash(Encoding.Default.GetBytes(string.Concat(key, secret, body.Trim()))));
}
}Copier après la connexion
以上就是Api项目端的各个核心环节的详细介绍。
接下来会对调用端即前端进行简单的介绍。Asp.net（三）Web端展示
Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!
![[Web front-end] Démarrage rapide de Node.js](https://img.php.cn/upload/course/000/000/067/662b5d34ba7c0227.png)
