我们继续我们的这一课时,回顾一下,上一节, 我们做了最重要的事情,就是打通了数据库的读及连接,为我们下面乃至后面的实战打下了坚实的基础,以后的工作和思路不外乎多表联查、服务器性能提升而已!再没有比第二节更多的东西了。
我们来继续我们的内容,将接口的返回数据进行规范统一。做过前端的都知道,接口返回必须有业务逻辑状态,根据不同的状态跳转不同的页面、做不同的逻辑动作。所以,此时这个业务逻辑状态犹为重要。注意这个是业务逻辑状态,并不是HTTP的连接等状态,HTTP的状态,我们根本不用关心,服务端也不必返回HTTP的状态,客户端到服务端负责通讯的类本身就有这个状态,服务端再勉强返回,就太不专业了。
任何接口都应该返回int status、object data、string msg这三个共同的属性。前端根据状态值做不同的业务逻辑,msg用于在一些情况直接展示接口返回的文本进行提示而不必在前端写死。所以,我们有必要定义一个类,所有接口的返回都必须是这个类。
在项目的Models文件夹上右键,添加->类,命名为ApiModel
我们为此类添加以下字段属性,你也看到了,我开始给代码添加简单又有必要的注释了,这是个很好的习惯,以后写代码,都需要添加注释,有利于你进行业务处理和代码的理解。
接口返回JSON数据,其实本身就有相应的类,我们改造一下,看看结果:
运行起来看看此时的接口返回数据:
https://localhost:44378/api/User/
可以看到,返回的是已经是一个标准的JSON序列化数据了。如果你够仔细,你应该可以看到数据里多了一些空格!这个后面我们会讲解原因。你先关注格式即可。
现在我们来改造接口,让它返回我们指定格式的数据。参考以下图,全局设置返回格式,我们只需要清除掉默认的XML格式就可以了。
GlobalConfiguration.Configuration.Formatters.XmlFormatter.SupportedMediaTypes.Clear();
保存运行,我们再来看看接口的返回:可以看到,格式已经改过来了。
我们现在来看看,数据的问题。我们期望的接口返回的数据应该是如下格式:
{"status":1,"data":[{"id":"1265984563","name":"Bill","sex":"f ","mobile":null,"nickName":null,"address":null,"headerIcon":null,"birthDay":null,"password":null}],"msg":"查询成功"}
特点:"data":[],而不是"data":"[]",如果你给带个双引号,也没有问题,但是这就导致在前端解析的时候,尤其是APP解析的时候,解析器得工作两次,将data这个字符串取出来再解析一次,才能得到前端期待的数据!这当然是不可以的,也是不允许的!性能为王的今天,怎么可以重复的去做同一个事情呢?但是,我们的接口返回却。。。
第一、上面数据的data节点应该是个对象的,但是却是个字符串?
第二、部分字段出现多余的空格,这又是什么情况?
好,我们来一一处理解决。
为什么会是个字符串,这是因为我们多余的为对象进行序列化导致的!我们只需要将以下所示之处稍作修改即可:
再次运行起来,我们看看效果,是不是已经为"data":[] 正常了?!!!!
第二个问题,出现多余的空格,这简直流氓的不要不要的!产生的原因就是我们数据库表设计的时候,列的属性为nchar类型,这类型的特点与varchar等相比较,同学们自行搜索学习一下就行了,这里不深入去探讨。既然是表的问题,那我们改一下就行了。打开数据库SSMS客户端:重新设计以下表,将列的属性修改为:varchar,保存文件。
保存时,它会提醒你:
点击是即可。什么时候使用nchar,什么时候使用varchar,后面我们再深入学习讨论,此处暂时忽略,你如果自己感兴趣,可以自行搜索学习。
修改完成后,你先别急着去吃灰去运行项目,数据库修改了,我们的EF数据模型还没有更新!你现在运行结果不变,还是一堆空白!!!
选择DataProvider项目,双击Model.edmx文件:
在空白处右键,选择"从数据库更新模型",再次对数据模型更新一下。
因为我们没再增加新表,所以,表区域没有新的的表,直接点击完成即可。
数据问题是因为在第二讲里面插入的时候,就已经因为类型出问题了,所以, 我们把表中的数据更新一下。
再来运行项目,我们看看接口的返回!可以看到,我们面临的问题都已经解决!
{"status":1,"data":[{"id":"1265984563","name":"bills","sex":"f","mobile":null,"nickName":null,"address":null,"headerIcon":null,"birthDay":null,"password":null}],"msg":"查询成功"}
本节教程就到此为止,下一节,我们来继续数据库方面的写操作,会读会写了,基本上教程的内容就涉及的差不多了!。
.NET WebApi 实战第四讲:EF进行数据库的写操作