Как да създадете глобални променливи, достъпни във всички изгледи с помощта на Express / Node.JS?

След като имах възможност да проуча Справочника за API на Express 3, открих още малко това, което търсих. По-конкретно записите за app.locals и след това малко по-надолу < a href="http://expressjs.com/api.html#res.locals" rel="noreferrer">res.locals съдържаше отговорите, от които се нуждаех.

За себе си открих, че функцията app.locals взема обект и съхранява всички негови свойства като глобални променливи, обхванати от приложението. Тези глобални стойности се предават като локални променливи към всеки изглед. Функцията res.locals обаче е с обхват на заявката и по този начин локалните променливи на отговора са достъпни само за изгледа(ите), изобразени по време на тази конкретна заявка/отговор.

Така че за моя случай в моя app.js това, което направих, беше да добавя:

app.locals({
    site: {
        title: 'ExpressBootstrapEJS',
        description: 'A boilerplate for a simple web application with a Node.JS and Express backend, with an EJS template with using Twitter Bootstrap.'
    },
    author: {
        name: 'Cory Gross',
        contact: '[email protected]'
    }
});

Тогава всички тези променливи са достъпни в моите изгледи като site.title, site.description, author.name, author.contact.

Бих могъл също да дефинирам локални променливи за всеки отговор на заявка с res.locals или просто да предам променливи като заглавието на страницата като optionsпараметър в извикването render.

РЕДАКТИРАНЕ: Този метод няма да ви позволи да използвате тези локални файлове във вашия междинен софтуер. Всъщност се натъкнах на това, както Пикълс предлага в коментара по-долу. В този случай ще трябва да създадете функция на мидълуер като такава в неговия алтернативен (и оценен) отговор. Вашата междинна функция ще трябва да ги добави към res.locals за всеки отговор и след това да извика next. Тази функция на междинния софтуер ще трябва да бъде поставена над всеки друг междинен софтуер, който трябва да използва тези локални.

РЕДАКТИРАНЕ: Друга разлика между декларирането на локални чрез app.locals и res.locals е, че с app.locals променливите се задават еднократно и се запазват през целия живот на приложението. Когато зададете локални с res.locals във вашия междинен софтуер, те се задават всеки път, когато получите заявка. По принцип трябва да предпочитате да задавате глобални стойности чрез app.locals, освен ако стойността не зависи от променливата req на заявката, подадена в междинния софтуер. Ако стойността не се промени, тогава ще бъде по-ефективно да бъде зададена само веднъж в app.locals.

Можете да направите това, като ги добавите към обекта locals в общ междинен софтуер.

app.use(function (req, res, next) {
   res.locals = {
     siteTitle: "My Website's Title",
     pageTitle: "The Home Page",
     author: "Cory Gross",
     description: "My app's description",
   };
   next();
});

Locals също е функция, която ще разшири обекта locals, вместо да го презаписва. Така че и следното работи

res.locals({
  siteTitle: "My Website's Title",
  pageTitle: "The Home Page",
  author: "Cory Gross",
  description: "My app's description",
});

Пълен пример

var app = express();

var middleware = {

    render: function (view) {
        return function (req, res, next) {
            res.render(view);
        }
    },

    globalLocals: function (req, res, next) {
        res.locals({ 
            siteTitle: "My Website's Title",
            pageTitle: "The Root Splash Page",
            author: "Cory Gross",
            description: "My app's description",
        });
        next();
    },

    index: function (req, res, next) {
        res.locals({
            indexSpecificData: someData
        });
        next();
    }

};


app.use(middleware.globalLocals);
app.get('/', middleware.index, middleware.render('home'));
app.get('/products', middleware.products, middleware.render('products'));

Добавих и общ мидълуер за рендиране. По този начин не е необходимо да добавяте res.render към всеки маршрут, което означава, че имате по-добро повторно използване на кода. След като тръгнете по пътя на междинния софтуер за многократна употреба, ще забележите, че ще имате много градивни елементи, които ще ускорят неимоверно разработката.

За Express 4.0 открих, че използването на променливи на ниво приложение работи малко по-различно и отговорът на Кори не работи за мен.

От документите: http://expressjs.com/en/api.html#app.locals

Открих, че можете да декларирате глобална променлива за приложението в

app.locals

e.g

app.locals.baseUrl = "http://www.google.com"

И тогава във вашето приложение можете да получите достъп до тези променливи и във вашия експресен междинен софтуер можете да получите достъп до тях в обекта req като

req.app.locals.baseUrl

e.g.

console.log(req.app.locals.baseUrl)
//prints out http://www.google.com

Във вашия app.js трябва да добавите нещо подобно

global.myvar = 100;

Сега, във всички ваши файлове, които искате да използвате тази променлива, можете просто да получите достъп до нея като myvar

можете също да използвате "глобален"

Пример:

декларирайте така:

  app.use(function(req,res,next){
      global.site_url = req.headers.host;   // hostname = 'localhost:8080'
      next();
   });

Използвайте така: във всеки изглед или ejs файл ‹% console.log(site_url); %>

в js файлове console.log(site_url);

Един от начините да направите това, като актуализирате променливата app.locals за това приложение в app.js

Задайте чрез следното

var app = express();
app.locals.appName = "DRC on FHIR";

Получи достъп

app.listen(3000, function () {
    console.log('[' + app.locals.appName + '] => app listening on port 3001!');
});

Разработване с екранна снимка от пример @RamRovi с леко подобрение.

С различните отговори внедрих този код, за да използвам външен файл JSON, зареден в „app.locals“

Параметри

{
    "web": {
        "title" : "Le titre de ma Page",
        "cssFile" : "20200608_1018.css"
    }
}

Приложение

var express     = require('express');
var appli       = express();
var serveur     = require('http').Server(appli);

var myParams    = require('./include/my_params.json');
var myFonctions = require('./include/my_fonctions.js');

appli.locals = myParams;

EJS страница

<!DOCTYPE html>
<html lang="fr">
<head>
    <meta charset="UTF-8">
    <title><%= web.title %></title>
    <link rel="stylesheet" type="text/css" href="/bg/css/<%= web.cssFile %>">
</head>

</body>
</html>

Надявайки се, че ще помогне

Това, което правя, за да избегна замърсен глобален обхват, е да създам скрипт, който мога да включа навсякъде.

// my-script.js
const ActionsOverTime = require('@bigteam/node-aot').ActionsOverTime;
const config = require('../../config/config').actionsOverTime;
let aotInstance;

(function () {
  if (!aotInstance) {
    console.log('Create new aot instance');
    aotInstance = ActionsOverTime.createActionOverTimeEmitter(config);
  }
})();

exports = aotInstance;

Това ще създаде нов екземпляр само веднъж и ще го сподели навсякъде, където е включен файлът. Не съм сигурен дали това е така, защото променливата е кеширана или поради вътрешен референтен механизъм за приложението (който може да включва кеширане). Всички коментари за това как възелът разрешава това биха били страхотни.

Може също да прочетете това, за да разберете как работи require: http://fredkschott.com/post/2014/06/require-and-the-module-system/