通用接口设计（接口的设计）

本文目录一览：

• 1、现在很多平台都提供有API接口，我自己的软件能不能设计一个API接口来和多个平台的API接口对接？

• 2、为什么 USB 接口设计之初选择了不能正反插的方案？

• 3、哪位大神能提供下VISA国际通用接口安装标准，就是电视机壁挂设计标准，谢谢了

• 4、App 和 Web 的通用接口该怎么设计

现在很多平台都提供有API接口，我自己的软件能不能设计一个API接口来和多个平台的API接口对接？

API通用接口，给软件预留的外部连接接口，是按照自己的一套规则体系设计的接口，由于各软件设计的规则和应用条件不同，基本上是不可能你一个API接口就能对接多个平台的。尤其是百度、360这样的大公司，只能是你按照他们的规则要求去做设计去适应他们的要求！

为什么 USB 接口设计之初选择了不能正反插的方案？

因为它主要是方便计算机和外置设备连接而设计的。接口在推出之后被迅速推广到其他设备上，为它们提供数据传输、供电功能，同时也延伸出不少自带 USB 口的设备。

虽然，USB-A 口的出现为我们带来不少方便。但大家其实也发现，绝大部分的 USB-A 接口是不能同时兼容正插和反插。

要是设备放在一些空间比较狭窄的地方，人不方便判断接口的正反向时，要将数据线接到接口上就变成了一件很麻烦的事。幸好，现在也推出了能兼容正反插的 USB-C 口和 Lightning 接口，用起来也更方便一些。

针对 USB-A 接口不能同时兼容正反插这个问题，USB 接口的联合开发者 Ajay Bhatt 就在与 NPR 的访问中做了解释。他表示，USB-A 没有用上正反插兼容的设计主要还是跟成本有关。

根据 The Verge 的报道，Bhatt 在设计这种通用接口的时候做过很多尝试。他希望这个接口能够兼容绝大部分的设备，也同时要要足够简单。他在接受 PC World 的访问时就用一个简单的例子来说明他的设计用意：

当年我们做这个接口的时候，就是希望它能够解决 90 年代的线缆连接问题。以前的插头和连接器太多了，很复杂，人们用起来其实并不方便。我是希望能有一个接口，可以帮助一般的家庭能快速把计算机和打印机连接起来，并且能够打印他们需要的东西。只要这个接口足够方便，他们接上就会用，同时也不需要每次都打电话来向我求助，那我觉得这样的接口就足够。

的确，USB-A 的出现为不少设备的连接提供便利性。它不仅能够用于简单的数据传输和供电，自带处理功能的设备也可以通过 USB 接口连接外置储存设备，并直接播放里面的内容。

例如，现在有不少汽车里面都附带了一个 USB 接口，车主只需要把 U 盘接进去就能直接播放歌曲。对比起还要自己改造车内播放设备的以前，这样的设计确实方便不少。

不过，Bhatt 也在访问中提到这种 USB 接口时遇到的问题，那就是接口的正反插兼容设计和成本之间的问题：

要让 USB 接口做到正反插都能兼容，其实并不容易。如果要用上这种设计，那就必须在 USB 接口上嵌入多一倍的电线和电路，那成本也必定要翻倍。

Bhatt 还提到，他们也考虑过方便盲插的圆形接口。但同样也因为成本的问题，最终也未能采用圆形接口的方案。

毕竟，通用接口还是要以普及为主要目标，要是在功能没有太大差距但却要付出更多的成本，那厂商和用户自然也不会接受。所以，Bhatt 在这里选择也正确的，他为 USB-A 挑选了成本更低也能保持方便的方案，也为这个接口带来了普及的机会。

和 USB-A 比起来，USB-C 口体积更小，功能集成度和性能都要比 USB-A 要高，设备通过一个 USB-C 口就可以完成供电、数据传输、显示传输等多个功能。

哪位大神能提供下VISA国际通用接口安装标准，就是电视机壁挂设计标准，谢谢了

VISA国际通用接口安装标准，孔距尺寸（上下尺寸）分别有：75*75mm、100*100mm、200*150mm、200*200mm、275*275mm、430*275mm、400*350mm、400*400mm、450*330mm、740*450等尺寸及范围。

App 和 Web 的通用接口该怎么设计

1、在接口定义中确定MVC的GET或者POST方式

由于我们整个Web API平台是基于MVC的基础上进行的API开发，因此整个Web API的接口，在定义的时候，一般需要显示来声明接口是[HttpGet]或者[HttpPost]，虽然有些接口也可以不用声明，但是避免出现类似下面的错误信息，显式声明还是有好处的。

请求的资源不支持 http 方法“POST

例如在基类定义的查找对象接口如下所示。

/// summary

/// 查询数据库,检查是否存在指定ID的对象

/// /summary

/// param name="id"对象的ID值/param

/// returns存在则返回指定的对象,否则返回Null/returns

[HttpGet]

public virtual T FindByID(string id, string token)

如果是增删改的接口，一般需要声明为POST方式提交数据，而且基于安全性的考虑，需要携带更多的参数。

/// summary

/// 插入指定对象到数据库中

/// /summary

/// param name="info"指定的对象/param

/// returns执行操作是否成功。/returns

[HttpPost]

public virtual CommonResult Insert(T info, string token, string signature, string timestamp, string nonce, string appid)

2、动态对象的接口定义

在一般的Web API接口里面，我们可能都会碰到很多简单类型的参数，但是又想让它们以POST方式提交数据，那么我们就可以有两种方法来处理，一种是定义一个类来放置这些参数，一种是采用动态的JObject参数，前者有很多不方便的地方，因为我们不可能为每个接口参数定义多一个实体类，这样可能会有很多难以管理的类定义。如下面是微信API的调用接口案例，我们也需要设置这样的处理规则。

接口调用请求说明

http请求方式: POST（请使用https协议）

POST数据格式：json

POST数据例子：{"group":{"id":108,"name":"test2_modify2"}}

那么我们采用JObject是这么样的呢，我们来看接口的定义和处理代码。JObject是Newtonsoft.Json.Linq命名空间下的一个对象。

/// summary

/// 修改用户密码

/// /summary

/// param name="param"包含userName和userPassword的复合对象/param

/// param name="token"用户访问令牌/param

/// returns/returns

[HttpPost]

public CommonResult ModifyPassword(JObject param,  string token)

{

//令牌检查,不通过则抛出异常

CheckResult checkResult = CheckToken(token);

dynamic obj = param;

if (obj != null)

{

string userName = obj.userName;

string userPassword = obj.userPassword;

bool success = BLLFactoryUser.Instance.ModifyPassword(userName, userPassword);

return new CommonResult(success);

}

else

{

throw new MyApiException("传递参数出现错误");

}

}

其中我们把JObject对象转换为我们所需要的对象的时候，因为我们没有定义具体的实体类，因此采用了dynamic语法，声明这是一个动态对象，由运行时获取对应的属性。

dynamic obj = param;

这样我们就可以在调用的时候，动态POST对应的JSON对象给Web API接口，而不需要预先定义各种接口参数的类了。

/// summary

/// 调用Web API接口，修改用户密码

/// /summary

/// param name="userName"用户名称/param

/// param name="userPassword"修改的密码/param

/// returns如果修改成功返回true，否则返回false/returns

public bool ModifyPassword(string userName, string userPassword)

{

var action = "ModifyPassword";

var postData = new

{

userName = userName,

userPassword = userPassword

}.ToJson();

string url = GetTokenUrl(action);

CommonResult result = JsonHelperCommonResult.ConvertJson(url, postData);

return (result != null) ? result.Success : false;

}

其中GetTokenUrl是根据token和API的地址等参数，构建一个完整的提交地址。我们在上面代码通过

var postData = new

{

userName = userName,

userPassword = userPassword

}.ToJson();

就可以动态创建一个对象，并生成它的JSON字符串，把数据POST提交到对应的API接口里面即可，然后对结果进行对象的转换就算完成了。

3、集合和分页的处理

在很多接口里面，我们都需要用到分页的处理，Web API也不例外，这样可以提交数据检索效率，减少服务器数据处理的压力，同时也提交客户端的数据显示速度。

一般的集合接口定义如下所示（通用性基类接口）。

/// summary

/// 返回数据库所有的对象集合

/// /summary

/// returns指定对象的集合/returns

[HttpGet]

public virtual ListT GetAll(string token)

{

//检查用户是否有权限，否则抛出MyDenyAccessException异常

base.CheckAuthorized(AuthorizeKey.ListKey, token);

ListT list = baseBLL.GetAll();

return list;

}

但是这样的返回记录会比较多，一般情况下需要分页，那么分页的处理接口定义如下所示。

/// summary

/// 根据条件查询数据库,并返回对象集合(用于分页数据显示)

/// /summary

/// returns指定对象的集合/returns

[HttpPost]

public virtual PagedListT FindWithPager(string condition, PagerInfo pagerInfo, string token)

分页接口，在这里返回的结果里面，用了一个PageList的泛型类，这个方便我们获取当前的记录及总数，它的定义如下所示。

/// summary

/// 分页集合

/// /summary

/// typeparam name="T"对象/typeparam

public class PagedListT

{

/// summary

/// 返回记录的总数

/// /summary

public int total_count { get; set; }

/// summary

/// 列表集合

/// /summary

public ListT list { get; set; }

}

最后整个分页的处理Web API接口实现如下所示。

/// summary

/// 根据条件查询数据库,并返回对象集合(用于分页数据显示)

/// /summary

/// returns指定对象的集合/returns

[HttpPost]

public virtual PagedListT FindWithPager(string condition, PagerInfo pagerInfo, string token)

{

//检查用户是否有权限，否则抛出MyDenyAccessException异常

base.CheckAuthorized(AuthorizeKey.ListKey, token);

ListT list = baseBLL.FindWithPager(condition, pagerInfo);

//构造成Json的格式传递

var result = new PagedListT() { total_count = pagerInfo.RecordCount, list = list };

return result;

}

最后客户端调用分页的Web API代码如下所示。

/// summary

/// 根据条件查询数据库,并返回对象集合(用于分页数据显示)

/// /summary

/// param name="condition"查询的条件/param

/// param name="pagerInfo"分页实体/param

/// returns指定对象的集合/returns

public virtual ListT FindWithPager(string condition, ref PagerInfo pagerInfo)

{

var action = "FindWithPager";

string url = GetTokenUrl(action) + string.Format("condition={0}", condition);

var postData = pagerInfo.ToJson();

ListT result = new ListT();

PagedListT list = JsonHelperPagedListT.ConvertJson(url, postData);

if (list != null)

{

pagerInfo.RecordCount = list.total_count;//修改总记录数

result = list.list;

}

return result;

}

4、混合框架界面整合Web API接口

在整个Web API的平台构建以及在混合框架的整合过程中，我把各个模块还是遵循相对独立的方式进行开发和整合，它们实现了从直接访问数据库、以WCF服务获取数据，以及通过WebAPI调用方式获取数据几种方式的统一，从而实现了整个混合框架的高度整合。

整个混合框架的核心是以相对独立的方式，整合各个可重用的模块，我们可以遵循一定的基础上，快速构建统一的应用平台。

搭建完毕的整个WebAPI平台，其中包括了服务端内容，以API控制器的方式，发布了对应的Web API接口。

在每个混合框架的独立模块里面，我们封装了对应的Web API客户端调用处理，从而实现了Web API的调用方式。

在Win10下，使用Web API模式运行混合框架，获得的主体界面效果如下所示。

独立模块权限管理系统界面如下所示。

系列文章如下所示：

Web API应用架构在Winform混合框架中的应用（1）

Web API应用架构在Winform混合框架中的应用（2）--自定义异常结果的处理

Web API接口设计经验总结

Web API应用架构在Winform混合框架中的应用（3）--Winfrom界面调用WebAPI的过程分解

Web API应用架构在Winform混合框架中的应用（4）--利用代码生成工具快速开发整套应用

Web API应用架构在Winform混合框架中的应用（5）--系统级别字典和公司级别字典并存的处理方式

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。