Proxy

Last updated on 2021-02-06 22:10:83

Today, at the front and rear ends, cross-domain has become the basic knowledge that every front-end engineer needs to understand, and the Nikkei topic in various interview questions. This article is intended to summarize the past and present of the same-origin strategy and how to solve it.

Same-origin strategy

In MDN we can see that the same-origin policy is a security mechanism. The detailed description is as follows:

The same-origin policy limits how documents or scripts loaded from the same source interact with resources from another source. This is an important security mechanism for isolating potentially malicious files.

The starting point of this mechanism is very good, but the restrictions on homology are very strict. Any difference in url and port will cause cross-domain errors.

And you won't find any problems in the console. This is becoming more and more common as front and rear separations become more common. So how should it be solved?

图像 1.png

The same-origin policy is called "Bubble-to-Domain Strategy", which is a security mechanism built into the browser. Then we don't want to use a browser request to solve the problem perfectly. The most convenient for the front end is naturally node.js.

Used in development

All scaffolding on the market now provides proxy capabilities based on http-proxy-middleware .com/chimurai/http-proxy-middleware), this package can forward all requests that match the regular match to an address. Here is a simple demo:

var express = require('express');
var proxy = require('http-proxy-middleware');

var app = express();

app.use('/api', proxy({ target: 'http://www.example.org', changeOrigin: true }));
app.listen(3000);

// http://localhost:3000/api/foo/bar -> http://www.example.org/api/foo/bar

This configuration can forward all requests starting with /api to http://www.example.org/ with all the arguments, including headers and cookies. One thing to note is that the view in the browser console is still http://localhost:3000/api/xxx and the conversion steps are done in node.js.

In Pro, it is easier to configure with [proxy] in config.ts. Configuration may be like this:

 proxy: {
    '/server/api/': {
      target: 'https://preview.pro.ant.design/',
      changeOrigin: true,
      pathRewrite: { '^/server': '' },
    },
  },

Detailed configuration recommendations directly look at the configuration of webpack-dev.

CORS

If you think that the above changes require more configuration, the system is simpler and you don't need to introduce new complexity. We can use CORS to allow cross-domain calls, which can be set in express:

express config

res.header('Access-Control-Allow-Origin', '你的项目地址,用*将会带来安全问题');
res.header('Access-Control-Allow-Headers', '*');
res.header('Access-Control-Allow-Methods', '*');
res.header('Content-Type', 'application/json;charset=utf-8');

nginx config

location ^~ /api {
  proxy_set_header Origin '';
  add_header Access-Control-Allow-Credentials true;
  add_header Access-Control-Allow-Headers $http_access_control_request_headers;
  add_header Access-Control-Allow-Methods POST,GET,OPTIONS,DELETE,PUT,HEAD,PATCH;
  add_header Access-Control-Allow-Origin $http_origin;
  add_header Access-Control-Expose-Headers $http_access_control_request_headers;

  if ($request_method = 'OPTIONS') {
    return 204;
  }
  if ($request_method != 'OPTIONS'){
    proxy_pass "your serve url";
  }
}

It should be noted that before the current version of nginx 1.7.5, add_header is only effective for 2xx and 3xx requests. Headers of 5xx cannot add headers and will still be intercepted by the browser ’s cross-domain policy. Errors contained in the body of 5xx requests The information cannot be obtained by the front end.

java config

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class HttpErrorResponseUtil {
    public static void setResponeCorsHeader(HttpServletRequest request, HttpServletResponse response) {
      response.addHeader("Access-Control-Allow-Credentials", "true");
      response.addHeader("Access-Control-Allow-Methods", "POST,GET,OPTIONS,DELETE,PUT,HEAD,PATCH");
      response.addHeader("Access-Control-Allow-Origin", request.getHeader("Origin"));
      response.addHeader("Access-Control-Allow-Headers", request.getHeader("Access-Control-Request-Headers"));
    }
}

The methods are similar in other languages. The most important one is the corresponding setting of the Access-Control-Allow-Origin Access-Control-Allow-Headers Access-Control-Allow-Methods header.

It is highly recommended that everyone read through MDN's HTTP Access Control, and this illustrated article can resolve cross-domain percentages. Eighty doubts.

Advanced usage

n development we may need to distinguish between multiple situations, such as the development environment, test environment, grammar environment, and the environment variables we can use in Pro to achieve this requirement.

const serveUrlMap = {
  dev: 'https://dev.pro.ant.design/',
  pre: 'https://pre.pro.ant.design/',
  test: 'https://test.pro.ant.design/',
  idc: 'https://idc.pro.ant.design/',
};

const { SERVE_ENV = 'idc' } = process.env;

export default {
  // ....
  proxy: {
    '/server/api/': {
      target: serveUrlMap[SERVE_ENV],
      changeOrigin: true,
      pathRewrite: { '^/server': '' },
    },
  },
};

We can quickly switch by configuring various shortcut commands in package.json.

{
  "scripts": {
    "start:dev": "cross-env SERVE_ENV=dev umi dev",
    "start:pre": "cross-env SERVE_ENV=pre umi dev",
    "start:test": "cross-env SERVE_ENV=test umi dev"
  }
}

It is worth noting here that the environment of config.ts is the environment of node.js, which can not use the behavior of dom and browser.