Jak stworzyć zmienne globalne dostępne we wszystkich widokach za pomocą Express / Node.JS?

Ok, więc zbudowałem bloga używając Jekyll i możesz zdefiniować zmienne w pliku, _config.ymlktóre są dostępne we wszystkich szablonach / układach. Obecnie używam Node.JS / Express z szablonami EJS i lokalnymi ejs (dla częściowych / układów. Chcę zrobić coś podobnego do zmiennych globalnych, takich jak site.titlete, które można znaleźć w, _config.ymljeśli ktoś zna Jekyll. Mam zmienne takie jak tytuł witryny (zamiast tytułu strony), nazwa autora / firmy, które pozostają takie same na wszystkich moich stronach.

Oto przykład tego, co obecnie robię .:

exports.index = function(req, res){
    res.render('index', { 
        siteTitle: 'My Website Title',
        pageTitle: 'The Root Splash Page',
        author: 'Cory Gross',
        description: 'My app description',
        indexSpecificData: someData
    });
};

exports.home = function (req, res) {
    res.render('home', {
        siteTitle: 'My Website Title',
        pageTitle: 'The Home Page',
        author: 'Cory Gross',
        description: 'My app description',
        homeSpecificData: someOtherData
    });
};

Chciałbym móc zdefiniować zmienne, takie jak tytuł, opis, autor itp. Mojej witryny, w jednym miejscu i mieć je dostępne w moich układach / szablonach za pośrednictwem EJS bez konieczności przekazywania ich jako opcji do każdego wywołania res.render. Czy istnieje sposób, aby to zrobić i nadal pozwolić mi przekazywać inne zmienne specyficzne dla każdej strony?

Po dokładniejszym przestudiowaniu dokumentacji API Express 3 odkryłem, czego szukałem. W szczególności wpisy dotyczące, app.localsa następnie nieco dalej, res.localszawierały odpowiedzi, których potrzebowałem.

Sam odkryłem, że funkcja app.localspobiera obiekt i zapisuje wszystkie jego właściwości jako zmienne globalne w zakresie aplikacji. Te wartości globalne są przekazywane jako zmienne lokalne do każdego widoku. res.localsJednak zakres funkcji obejmuje żądanie, a zatem lokalne zmienne odpowiedzi są dostępne tylko dla widoków renderowanych podczas tego konkretnego żądania / odpowiedzi.

Więc dla mojego przypadku w moim app.jstym, co zrobiłem, było dodanie:

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]'
    }
});

Następnie wszystkie te zmienne są dostępne w moich poglądów jak site.title, site.description, author.name, author.contact.

Mógłbym również zdefiniować zmienne lokalne dla każdej odpowiedzi na żądanie z res.localslub po prostu przekazać zmienne, takie jak tytuł strony, jako optionsparametr w renderwywołaniu.

EDYCJA: Ta metoda nie pozwoli ci na użycie tych lokalnych w twoim oprogramowaniu pośrednim. Właściwie natknąłem się na to, jak sugeruje Pickels w komentarzu poniżej. W takim przypadku będziesz musiał utworzyć funkcję oprogramowania pośredniego jako taką w jego alternatywnej (i docenianej) odpowiedzi. Twoja funkcja oprogramowania pośredniego będzie musiała dodać je do res.localskażdej odpowiedzi, a następnie wywołać next. Ta funkcja oprogramowania pośredniego będzie musiała zostać umieszczona nad jakimkolwiek innym oprogramowaniem pośrednim, które musi korzystać z tych lokalnych.

EDYCJA: Inną różnicą między deklarowaniem lokalizacji lokalnych za pośrednictwem app.localsi res.localsjest to, że app.localszmienne są ustawiane jednorazowo i trwają przez cały okres użytkowania aplikacji. Gdy ustawiasz lokalne res.localsw oprogramowaniu pośrednim, są one ustawiane za każdym razem, gdy otrzymasz żądanie. Zasadniczo powinieneś preferować ustawianie wartości globalnych via, app.localschyba że wartość zależy od reqzmiennej żądania przekazanej do oprogramowania pośredniego. Jeśli wartość się nie zmieni, bardziej wydajne będzie ustawienie jej tylko raz app.locals.

Możesz to zrobić, dodając je do obiektu lokalnego w ogólnym oprogramowaniu pośredniczącym.

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();
});

Lokalne to także funkcja, która rozszerza obiekt lokalny zamiast go nadpisywać. Więc poniższe działa również

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

Pełny przykład

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'));

Dodałem również ogólne oprogramowanie pośredniczące renderowania. W ten sposób nie musisz dodawać res.render do każdej trasy, co oznacza, że ​​masz lepsze możliwości ponownego wykorzystania kodu. Gdy przejdziesz ścieżką oprogramowania pośredniego wielokrotnego użytku, zauważysz, że masz wiele bloków konstrukcyjnych, które ogromnie przyspieszą rozwój.

W przypadku Express 4.0 stwierdziłem, że używanie zmiennych poziomu aplikacji działa trochę inaczej, a odpowiedź Cory'ego nie działa dla mnie.

Z dokumentów: http://expressjs.com/en/api.html#app.locals

Odkryłem, że możesz zadeklarować zmienną globalną dla aplikacji w

app.locals

na przykład

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

Następnie w swojej aplikacji możesz uzyskać dostęp do tych zmiennych, aw swoim ekspresowym oprogramowaniu pośrednim możesz uzyskać do nich dostęp w obiekcie req jako

req.app.locals.baseUrl

na przykład

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

W swoim app.js musisz dodać coś takiego

global.myvar = 100;

Teraz we wszystkich plikach, które chcesz użyć tej zmiennej, możesz uzyskać do niej dostęp jako myvar

Można to zrobić, aktualizując app.localszmienną dla tej aplikacji wapp.js

Ustaw za pomocą następujących

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

Uzyskać dostęp

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

Opracowanie ze zrzutem ekranu z przykładu @RamRovi z niewielkimi poprawkami.

możesz też użyć „globalnego”

Przykład:

zadeklaruj tak:

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

Użyj w ten sposób: w dowolnym widoku lub pliku ejs <% console.log (site_url); %>

w plikach js console.log (site_url);

Z różnymi odpowiedziami zaimplementowałem ten kod, aby użyć zewnętrznego pliku JSON załadowanego w „app.locals”

Parametry

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

Podanie

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;

Strona EJS

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

</body>
</html>

Mam nadzieję, że to pomoże

Aby uniknąć zanieczyszczonego zasięgu globalnego, tworzę skrypt, który mogę umieścić w dowolnym miejscu.

// 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;

W ten sposób utworzysz nową instancję tylko raz i udostępnisz ją wszędzie tam, gdzie znajduje się plik. Nie jestem pewien, czy dzieje się tak, ponieważ zmienna jest buforowana, czy też z powodu wewnętrznego mechanizmu referencyjnego dla aplikacji (który może obejmować buforowanie). Wszelkie komentarze na temat tego, jak węzeł rozwiązuje ten problem, byłyby świetne.

Może również przeczytaj to, aby dowiedzieć się, jak działa Wymaganie: http://fredkschott.com/post/2014/06/require-and-the-module-system/