Gulp browser-sync - 通过代理重定向 API 请求

Question

我正在尝试使用 gulp 和浏览器同步重定向我的 API 请求：

gulp.task('browser-sync', function () {

   var files = [
      '../index.html',
      '../views/**/*.html',
      '../assets/css/**/*.css',
      '../assets/js/**/*.js'
   ];

   var url = require('url'),
   proxy = require('proxy-middleware');
   var proxyOptions = url.parse('http://localhost:8000/api');
   proxyOptions.route = '/api';

   browserSync.init(files, {
      server: {
         baseDir: '..',
         middleware: [proxy(proxyOptions)]
      }
   });

});

但是当调用被发送到 API 时，我得到了这个响应：

Error: connect ECONNREFUSED
    at errnoException (net.js:904:11)
    at Object.afterConnect [as oncomplete] (net.js:895:19)

知道我做错了什么吗？

Answer 1

查看official documentation about using BrowserSync with Gulp。我能够在 /api 上使用代理启动 BrowserSync 并运行，没有任何问题。

检查以确保没有其他东西在使用端口 8000。您可以通过 port option when initializing BrowserSync 更改 BrowserSync 使用的端口。

这是我最终得到的gulpfile.js：

npm install gulp url proxy-middleware browser-sync --save-dev

// Include gulp
var gulp = require('gulp');

var url = require('url');
var proxy = require('proxy-middleware');
var browserSync = require('browser-sync'); 

var paths =  {
    css: ['./**/*.css', '!./node_modules/**/*']
};


// browser-sync task for starting the server.
gulp.task('browser-sync', function() {
    var proxyOptions = url.parse('http://localhost:3000/secret-api');
    proxyOptions.route = '/api';
    // requests to `/api/x/y/z` are proxied to `http://localhost:3000/secret-api/x/y/z`

    browserSync({
        open: true,
        port: 3000,
        server: {
            baseDir: "./",
            middleware: [proxy(proxyOptions)]
        }
    });
});

// Stream the style changes to the page
gulp.task('reload-css', function() {
    gulp.src(paths.css)
        .pipe(browserSync.reload({stream: true}));
});

// Watch Files For Changes
gulp.task('watch', function() {
    gulp.watch(paths.css, ['reload-css']);
});

// Default Task
gulp.task('default', ['browser-sync', 'watch']);

如果您不想创建单独的 gulp 任务来重新加载/流式传输更改，您可以使用 files option:

browserSync({
    open: true,
    port: 3000,
    server: {
        baseDir: "./",
        middleware: [proxy(proxyOptions)]
    },
    files: paths.css
});

Answer 2

在从 grunt 迁移到 gulp 时，我在 gulp + browser-sync + proxy-middleware 设置中遇到了同样的问题。

Error: connect ECONNREFUSED
    at errnoException (net.js:904:11)
    at Object.afterConnect [as oncomplete] (net.js:895:19)

在我的情况下，公司网络中的某些东西不允许代理中间件工作。我一上公共网络，问题就消失了。

使用 grunt-connect + grunt-connect-proxy，我可以毫无问题地代理公司网络内的文件。

proxy-middleware 实现自己的代理功能，而 grunt-connect-proxy 使用 http-proxy 来完成实际的代理工作。

我最终围绕 http-proxy 编写了一个小型中间件包装器，用于浏览器同步和连接，这解决了公司网络中的代理问题。

https://www.npmjs.com/package/http-proxy-middleware

var browserSync = require('browser-sync');
var proxyMiddleware = require('http-proxy-middleware');

var proxy = proxyMiddleware('/ajax', {target: 'http://cdnjs.cloudflare.com'});

browserSync({
    server: {
        baseDir: "./",
        port: 3000,
        middleware: [proxy]
    }
});

Answer 3

我遇到了一个问题，我找不到解决方案。我需要两种选择：

1. browser-sync 运行在SPA mode
2. 在/api 路由上有middleware 代理

SPA 模式似乎拦截了/api 并呈现index.html 而不是代理到后端。

解决方案在browser-syncsources：使用middleware路由实现单模式，比手动添加的优先级更高：

        if (bs.options.get("single")) {
            defaultMiddlewares.unshift({
                id: "Browsersync SPA support",
                route: "",
                handle: require("connect-history-api-fallback")()
            });
        }

以下配置根据需要工作 - SPA 路由位于中间件列表的末尾：

const proxy = require('proxy-middleware');
...
    server.init({
        ...
        middleware: [ {
            route: "/api",
            handle: proxy(url.parse("http://api.host:4444/api"))
        }, {
            id: "SPA support",
            route: "",
            handle: require("connect-history-api-fallback")()
        } ],
        single: false,
        ...
    })