问题描述
当跨域(cross domain)调用ASP.NET MVC或者ASP.NET Web API编写的服务时,会发生无法访问的情况。
重现方式
- 使用模板创建一个最简单的ASP.NET Web API项目,调试起来确认能正常工作
- public class UserController : ApiController
- {
- public UserModel getInfo()
- {
- UserModel um = new UserModel();
- um.Uid = 5;
- um.UserName = "addddn";
- um.Age = 117;
- return um;
- }
12.}
13.public class UserModel
- {
- public int Uid { get; set; }//编号
- public string UserName { get; set; }//姓名
- public int Age { get; set; }//年龄
- }
- 创建另外一个项目,仅仅包含一个HTML页面,发起AJAX的调用
20.<script type="text/javascript">
- window.onload = function get() {
- $.ajax({
- type: 'GET',
- url: 'http://192.168.10.106:8088/api/user/getInfo',
dataType: 'json',
- success: function (data, textStatus) {
- alert(data.Uid + " | " + data.UserName + "|" + data.Age);
- },
- error: function (xmlHttpRequest, textStatus, errorThrown) {
- }
- });
- }
- 在浏览器中打开这个网页,我们会发现如下的错误(405:Method Not Allowed)
【备注】同样的情况,也发生在ASP.NET MVC中。某些时候,MVC也可以直接用来开发服务,与WebAPI相比各有优缺点。下面是一个利用MVC开发的服务的例子
- public ActionResult Index()
{
UserModel um = new UserModel();
um.Uid = 5;
- um.UserName = "addddn";
- um.Age = 117;
return Json(um, JsonRequestBehavior.AllowGet);
}
原因分析
跨域问题仅仅发生在Javascript发起AJAX调用,或者Silverlight发起服务调用时,其根本原因是因为浏览器对于这两种请求,所给予的权限是较低的,通常只允许调用本域中的资源,除非目标服务器明确地告知它允许跨域调用。
所以,跨域的问题虽然是由于浏览器的行为产生出来的,但解决的方法却是在服务端。因为不可能要求所有客户端降低安全性。
解决方案1
针对ASP.NET MVC和ASP.NET Web API两种项目类型,我做了一些研究,确定下面的方案是可行的。
针对ASP.NET MVC,只需要在web.config中添加如下红色的内容即可
<system.webServer>
<httpProtocol>
<customHeaders>
<add name="Access-Control-Allow-Origin" value="*" />
<add name="Access-Control-Allow-Headers" value="Content-Type" />
<add name="Access-Control-Allow-Methods" value="GET, POST, PUT, DELETE, OPTIONS" />
</customHeaders>
</httpProtocol>
</system.webServer>
针对ASP.NET Web API,除了上面这样的设置,还需要添加一个特殊的设计,就是为每个APIController添加一个OPTIONS的方法,但无需返回任何东西。
public string Options()
{
return null; // HTTP 200 response with empty body
}
【备注】这个功能也可以进行一些研究,设计成Filter的形式可能就更好了。
解决方案2(针对MVC)
下面的index是需要调用的方法
public ActionResult Index()
{
string t = requestURL("http://192.168.1.3/api/user/getInfo");
JsonData js = JsonMapper.ToObject(t);
String name = (String)js["UserName"];
return Content(name);
}
public static string requestURL (string url)
{
string strURL = url;
System.Net.HttpWebRequest request;
request = (System.Net.HttpWebRequest)WebRequest.Create(strURL);
request.Method = "GET";
System.Net.HttpWebResponse response;
response = (System.Net.HttpWebResponse)request.GetResponse();
System.IO.Stream s;
s = response.GetResponseStream();
string StrDate = "";
string strValue = "";
StreamReader Reader = new StreamReader(s, Encoding.UTF8);
while ((StrDate = Reader.ReadLine()) != null)
{
strValue += StrDate + "
";
}
return strValue;
}