.net core实现跨域

时间 2019-11-22

标签 core 实现繁體版

原文原文链接

什么是跨域在前面已经讲解过了，这里便再也不讲解，直接上代码。html

1、后台API接口

用.net core建立一个Web API项目负责给前端界面提供数据。前端

2、前端界面

创建两个MVC项目，模拟不一样的ip，在view里面添加按钮调用WEB API提供的接口进行测试跨域。view视图页代码以下：jquery

@{
    Layout = null;
}

<!DOCTYPE html>

<html>
<head>
    <meta name="viewport" content="width=device-width" />
    <title>跨域测试1</title>
    <script src="~/Scripts/jquery-1.10.2.js"></script>
    <script>
        function btnGet() {
            $.ajax({
                url: 'https://localhost:44355/api/values',
                type: "Get",
                dataType: "json",
                success: function (data) {
                    alert("成功");
                },
                error: function (data) {
                    alert("失败");
                }
            });
        }
    </script>
</head>
<body>
    <div> 
        <input type="button" id="btn" value="测试跨域" onclick="btnGet()" />
    </div>
</body>
</html>

3、测试

一、不设置容许跨域

首先，先不设置.net core容许跨域，查看调用效果：ajax

点击测试跨域1按钮：json

F12进入Debug模式查看失败缘由：api

从这里能够看出来是由于产生了跨域问题，因此会失败。跨域

点击测试跨域2的效果和此效果一致。数组

二、设置容许全部来源跨域

2.一、在StartUp类的ConfigureServices方法中添加以下代码：app

// 配置跨域处理，容许全部来源
services.AddCors(options =>
options.AddPolicy("cors",
p => p.AllowAnyOrigin().AllowAnyHeader().AllowAnyMethod().AllowCredentials()));

2.二、修改Configure方法cors

// 容许全部跨域，cors是在ConfigureServices方法中配置的跨域策略名称
app.UseCors("cors");

2.三、测试

从截图中能够看出，此次调用成功了。

三、设置特定来源能够跨域

3.一、修改ConfigureServices方法代码以下：

//容许一个或多个来源能够跨域
services.AddCors(options =>
{
      options.AddPolicy("CustomCorsPolicy", policy =>
      {
             // 设定容许跨域的来源，有多个能够用','隔开
             policy.WithOrigins("http://localhost:21632")
             .AllowAnyHeader()
             .AllowAnyMethod()
             .AllowCredentials();
      });
});

这里设置只容许ip为http://localhost:21632的来源容许跨域。

3.二、修改Configure代码以下：

// 设定特定ip容许跨域 CustomCorsPolicy是在ConfigureServices方法中配置的跨域策略名称
app.UseCors("CustomCorsPolicy");

3.3测试

点击跨域测试1按钮，结果以下：

能够看到访问成功了，而后在点击跨域测试2按钮，结果以下：

发现此次访问失败了，F12进入Debug模式，查看失败缘由：

从截图中能够看出是由于这里产生了跨域请求，可是没有容许跨域测试2所在的ip跨域。那么若是也想让跨域测试2能够调用成功该怎么办呢？

光标定位到WithOrigins上面，而后F12查看定义：

从截图中发现：WithOrigins的参数是一个params类型的字符串数组，若是要容许多个来源能够跨域，只要传一个字符串数组就能够了，因此代码修改以下：

//容许一个或多个来源能够跨域
services.AddCors(options =>
{
      options.AddPolicy("CustomCorsPolicy", policy =>
      {
            // 设定容许跨域的来源，有多个能够用','隔开
            policy.WithOrigins("http://localhost:21632", "http://localhost:24661")
            .AllowAnyHeader()
            .AllowAnyMethod()
            .AllowCredentials();
      });
});

这时跨域测试2也能够调用成功了

四、优化

在上面的例子中，须要分两步进行设置才能够容许跨域，有没有一种方法只须要设置一次就能够呢？在Configure方法中只设置一次便可，代码以下：

// 设置容许全部来源跨域
app.UseCors(options =>
{
       options.AllowAnyHeader();
       options.AllowAnyMethod();
       options.AllowAnyOrigin();
       options.AllowCredentials();
});

// 设置只容许特定来源能够跨域
app.UseCors(options =>
{
        options.WithOrigins("http://localhost:3000", "http://127.0.0.1"); // 容许特定ip跨域
        options.AllowAnyHeader();
        options.AllowAnyMethod();
        options.AllowCredentials();
});

五、利用配置文件实现跨域

在上面的示例中，都是直接把ip写在了程序里面，若是要增长或者修改容许跨域的ip就要修改代码，这样很是不方便，那么能不能利用配置文件实现呢？看下面的例子。

5.一、修改appsettings.json文件以下：

{
  "Logging": {
    "LogLevel": {
      "Default": "Warning"
    }
  },
  "AllowedHosts": {
    "url": "http://localhost:21632|http://localhost:24663"
  }
}

AllowedHosts里面设置的是容许跨域的ip，多个ip直接用“|”进行拼接，也能够用其余符合进行拼接。

5.二、增长CorsOptions实体类

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace CorsDomainDemo
{
    public class CorsOptions
    {
        public string url { get; set; }
    }
}

5.三、新增OptionConfigure方法

private void OptionConfigure(IServiceCollection services)
{
    services.Configure<CorsOptions>(Configuration.GetSection("AllowedHosts"));
}

5.四、在ConfigureServices方法里面调用OptionConfigure方法

// 读取配置文件内容
OptionConfigure(services);

5.五、修改Configure方法，增长IOptions<CorsOptions>类型的参数，最终代码以下

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.HttpsPolicy;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;

namespace CorsDomainDemo
{
    public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        public IConfiguration Configuration { get; }

        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
            // 配置跨域处理，容许全部来源
            //services.AddCors(options =>
            //options.AddPolicy("cors",
            //p => p.AllowAnyOrigin().AllowAnyHeader().AllowAnyMethod().AllowCredentials()));

            //容许一个或多个来源能够跨域
            //services.AddCors(options =>
            //{
            //    options.AddPolicy("CustomCorsPolicy", policy =>
            //    {
            //        // 设定容许跨域的来源，有多个能够用','隔开
            //        policy.WithOrigins("http://localhost:21632", "http://localhost:24661")
            //          .AllowAnyHeader()
            //           .AllowAnyMethod()
            //           .AllowCredentials();
            //    });
            //});

            // 读取配置文件内容
            OptionConfigure(services);
            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
        }

        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IHostingEnvironment env, IOptions<CorsOptions> corsOptions)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }
            else
            {
                app.UseHsts();
            }

            // 容许全部跨域，cors是在ConfigureServices方法中配置的跨域策略名称
            //app.UseCors("cors");

            // 设定特定ip容许跨域 CustomCorsPolicy是在ConfigureServices方法中配置的跨域策略名称
            //app.UseCors("CustomCorsPolicy");

            // 设置容许全部来源跨域
            //app.UseCors(options =>
            //{
            //    options.AllowAnyHeader();
            //    options.AllowAnyMethod();
            //    options.AllowAnyOrigin();
            //    options.AllowCredentials();
            //});

            // 设置只容许特定来源能够跨域
            //app.UseCors(options =>
            //{
            //    options.WithOrigins("http://localhost:3000", "http://127.0.0.1"); // 容许特定ip跨域
            //    options.AllowAnyHeader();
            //    options.AllowAnyMethod();
            //    options.AllowCredentials();
            //});

            // 利用配置文件实现
            CorsOptions _corsOption = corsOptions.Value;
            // 分割成字符串数组
            string[] hosts = _corsOption.url.Split('|');

            // 设置跨域
            app.UseCors(options =>
            {
                options.WithOrigins(hosts);
                options.AllowAnyHeader();
                options.AllowAnyMethod();
                options.AllowCredentials();
            });

            app.UseHttpsRedirection();
            app.UseMvc();
        }

        private void OptionConfigure(IServiceCollection services)
        {
            services.Configure<CorsOptions>(Configuration.GetSection("AllowedHosts"));
        }
    }
}

这样就能够实现利用配置文件实现容许跨域了。