将字符串转换为模板字符串

Question

是否可以像普通字符串一样创建模板字符串，

let a = "b:${b}";

然后将其转换为模板字符串，

let b = 10;
console.log(a.template()); // b:10

没有eval、new Function等动态代码生成方式？

Answer 1

在我的项目中，我使用 ES6 创建了类似的东西：

String.prototype.interpolate = function(params) {
  const names = Object.keys(params);
  const vals = Object.values(params);
  return new Function(...names, `return \`${this}\`;`)(...vals);
}

const template = 'Example text: ${text}';
const result = template.interpolate({
  text: 'Foo Boo'
});
console.log(result);

Answer 2

由于您的模板字符串必须动态（在运行时）引用b 变量，所以答案是：不，没有动态代码生成是不可能的。

但是，eval 非常简单：

let tpl = eval('`'+a+'`');

Answer 3

不，没有动态代码生成就没有办法做到这一点。

但是，我创建了一个函数，它将常规字符串转换为一个函数，该函数可以在内部使用模板字符串提供值映射。

Generate Template String Gist

/**
 * Produces a function which uses template strings to do simple interpolation from objects.
 * 
 * Usage:
 *    var makeMeKing = generateTemplateString('${name} is now the king of ${country}!');
 * 
 *    console.log(makeMeKing({ name: 'Bryan', country: 'Scotland'}));
 *    // Logs 'Bryan is now the king of Scotland!'
 */
var generateTemplateString = (function(){
    var cache = {};

    function generateTemplate(template){
        var fn = cache[template];

        if (!fn){
            // Replace ${expressions} (etc) with ${map.expressions}.

            var sanitized = template
                .replace(/\$\{([\s]*[^;\s\{]+[\s]*)\}/g, function(_, match){
                    return `\$\{map.${match.trim()}\}`;
                    })
                // Afterwards, replace anything that's not ${map.expressions}' (etc) with a blank string.
                .replace(/(\$\{(?!map\.)[^}]+\})/g, '');

            fn = Function('map', `return \`${sanitized}\``);
        }

        return fn;
    }

    return generateTemplate;
})();

用法：

var kingMaker = generateTemplateString('${name} is king!');

console.log(kingMaker({name: 'Bryan'}));
// Logs 'Bryan is king!' to the console.

希望这对某人有所帮助。如果您发现代码有问题，请及时更新 Gist。

Answer 4

你在这里要求什么：

//non working code quoted from the question
let b=10;
console.log(a.template());//b:10

与eval 完全等效（在功率和安全性方面）：获取包含代码的字符串并执行该代码的能力；以及执行代码在调用者环境中查看局部变量的能力。

在 JS 中，函数无法在其调用者中查看局部变量，除非该函数是 eval()。连Function()都做不到。

---

当你听说 JavaScript 中出现了一种叫做“模板字符串”的东西时，很自然地会认为它是一个内置的模板库，比如 Mustache。它不是。主要是 string interpolation 和 JS 的多行字符串。不过，我认为这将在一段时间内成为一个普遍的误解。 :(

Answer 5

这里发布了许多好的解决方案，但还没有一个使用ES6 String.raw method。这是我的贡献。它有一个重要的限制，它只接受来自传入对象的属性，这意味着模板中的任何代码都不会执行。

function parseStringTemplate(str, obj) {
    let parts = str.split(/\$\{(?!\d)[\wæøåÆØÅ]*\}/);
    let args = str.match(/[^{\}]+(?=})/g) || [];
    let parameters = args.map(argument => obj[argument] || (obj[argument] === undefined ? "" : obj[argument]));
    return String.raw({ raw: parts }, ...parameters);
}

let template = "Hello, ${name}! Are you ${age} years old?";
let values = { name: "John Doe", age: 18 };

parseStringTemplate(template, values);
// output: Hello, John Doe! Are you 18 years old?

1. 将字符串拆分为非参数文本部分。见regex。
   parts: ["Hello, ", "! Are you ", " years old?"]
2. 将字符串拆分为属性名称。如果匹配失败，则为空数组。
   args: ["name", "age"]
3. 按属性名称映射来自obj 的参数。解决方案受到浅层映射的限制。未定义的值用空字符串替换，但也接受其他虚假值。
   parameters: ["John Doe", 18]
4. 使用String.raw(...) 并返回结果。

Answer 6

TLDR： https://jsfiddle.net/bj89zntu/1/

似乎每个人都担心访问变量。为什么不直接通过它们？我确信在调用者中获取变量上下文并将其传递下来不会太难。采用 ninjagecko's answer 获取 obj 的 props。

function renderString(str,obj){
    return str.replace(/\$\{(.+?)\}/g,(match,p1)=>{return index(obj,p1)})
}

这里是完整的代码：

function index(obj,is,value) {
    if (typeof is == 'string')
        is=is.split('.');
    if (is.length==1 && value!==undefined)
        return obj[is[0]] = value;
    else if (is.length==0)
        return obj;
    else
        return index(obj[is[0]],is.slice(1), value);
}

function renderString(str,obj){
    return str.replace(/\$\{.+?\}/g,(match)=>{return index(obj,match)})
}

renderString('abc${a}asdas',{a:23,b:44}) //abc23asdas
renderString('abc${a.c}asdas',{a:{c:22,d:55},b:44}) //abc22asdas

Answer 7

这里的问题是要有一个可以访问其调用者变量的函数。这就是为什么我们看到直接eval 被用于模板处理。一种可能的解决方案是生成一个函数，该函数采用由字典属性命名的形式参数，并以相同的顺序使用相应的值调用它。另一种方法是像这样简单：

var name = "John Smith";
var message = "Hello, my name is ${name}";
console.log(new Function('return `' + message + '`;')());

对于任何使用 Babel 编译器的人，我们需要创建一个闭包，它会记住创建它的环境：

console.log(new Function('name', 'return `' + message + '`;')(name));

Answer 8

与 Daniel 的回答（和 s.meijer 的 gist）类似，但更具可读性：

const regex = /\${[^{]+}/g;

export default function interpolate(template, variables, fallback) {
    return template.replace(regex, (match) => {
        const path = match.slice(2, -1).trim();
        return getObjPath(path, variables, fallback);
    });
}

//get the specified property or nested property of an object
function getObjPath(path, obj, fallback = '') {
    return path.split('.').reduce((res, key) => res[key] || fallback, obj);
}

注意：这略微改进了 s.meijer 的原始版本，因为它不会匹配 ${foo{bar} 之类的内容（正则表达式只允许在 ${ 和 } 中使用非大括号字符）。

---

更新：有人问我使用这个的例子，所以你去：

const replacements = {
    name: 'Bob',
    age: 37
}

interpolate('My name is ${name}, and I am ${age}.', replacements)

Answer 9

我喜欢 s.meijer 的回答，并根据他的回答编写了我自己的版本：

function parseTemplate(template, map, fallback) {
    return template.replace(/\$\{[^}]+\}/g, (match) => 
        match
            .slice(2, -1)
            .trim()
            .split(".")
            .reduce(
                (searchObject, key) => searchObject[key] || fallback || match,
                map
            )
    );
}

Answer 10

@Mateusz Moska，解决方案效果很好，但是当我在 React Native（构建模式）中使用它时，它会抛出一个错误：Invalid character '`'，虽然它在我运行它时可以工作调试模式。

所以我用正则表达式写下了我自己的解决方案。

String.prototype.interpolate = function(params) {
  let template = this
  for (let key in params) {
    template = template.replace(new RegExp('\\$\\{' + key + '\\}', 'g'), params[key])
  }
  return template
}

const template = 'Example text: ${text}',
  result = template.interpolate({
    text: 'Foo Boo'
  })

console.log(result)

演示： https://es6console.com/j31pqx1p/

注意：由于我不知道问题的根本原因，我在 react-native repo https://github.com/facebook/react-native/issues/14107 中提出了一张票，以便他们能够修复/指导我差不多:)

Answer 11

可以使用字符串原型，例如

String.prototype.toTemplate=function(){
    return eval('`'+this+'`');
}
//...
var a="b:${b}";
var b=10;
console.log(a.toTemplate());//b:10

但原问题的答案是不可能的。

Answer 12

我需要这种方法并支持 Internet Explorer。事实证明，即使 IE11 也不支持反引号。还;使用 eval 或等效的 Function 感觉不对。

对于注意到的人；我也使用反引号，但是这些反引号会被 babel 等编译器删除。其他人建议的方法取决于它们的运行时。如前所述；这是 IE11 及更低版本的问题。

所以这就是我想出的：

function get(path, obj, fb = `$\{${path}}`) {
  return path.split('.').reduce((res, key) => res[key] || fb, obj);
}

function parseTpl(template, map, fallback) {
  return template.replace(/\$\{.+?}/g, (match) => {
    const path = match.substr(2, match.length - 3).trim();
    return get(path, map, fallback);
  });
}

示例输出：

const data = { person: { name: 'John', age: 18 } };

parseTpl('Hi ${person.name} (${person.age})', data);
// output: Hi John (18)

parseTpl('Hello ${person.name} from ${person.city}', data);
// output: Hello John from ${person.city}

parseTpl('Hello ${person.name} from ${person.city}', data, '-');
// output: Hello John from -

Answer 13

我目前无法评论现有答案，因此我无法直接评论 Bryan Raynor 的出色回应。因此，此响应将通过稍微更正来更新他的答案。

简而言之，他的函数并没有真正缓存创建的函数，所以它总是会重新创建，不管它之前是否见过模板。这是更正后的代码：

    /**
     * Produces a function which uses template strings to do simple interpolation from objects.
     * 
     * Usage:
     *    var makeMeKing = generateTemplateString('${name} is now the king of ${country}!');
     * 
     *    console.log(makeMeKing({ name: 'Bryan', country: 'Scotland'}));
     *    // Logs 'Bryan is now the king of Scotland!'
     */
    var generateTemplateString = (function(){
        var cache = {};

        function generateTemplate(template){
            var fn = cache[template];

            if (!fn){
                // Replace ${expressions} (etc) with ${map.expressions}.

                var sanitized = template
                    .replace(/\$\{([\s]*[^;\s\{]+[\s]*)\}/g, function(_, match){
                        return `\$\{map.${match.trim()}\}`;
                    })
                    // Afterwards, replace anything that's not ${map.expressions}' (etc) with a blank string.
                    .replace(/(\$\{(?!map\.)[^}]+\})/g, '');

                fn = cache[template] = Function('map', `return \`${sanitized}\``);
            }

            return fn;
        };

        return generateTemplate;
    })();

Answer 14

仍然是动态的，但似乎比仅使用裸 eval 更受控制：

const vm = require('vm')
const moment = require('moment')


let template = '### ${context.hours_worked[0].value} \n Hours worked \n #### ${Math.abs(context.hours_worked_avg_diff[0].value)}% ${fns.gt0(context.hours_worked_avg_diff[0].value, "more", "less")} than usual on ${fns.getDOW(new Date())}'
let context = {
  hours_worked:[{value:10}],
  hours_worked_avg_diff:[{value:10}],

}


function getDOW(now) {
  return moment(now).locale('es').format('dddd')
}

function gt0(_in, tVal, fVal) {
  return _in >0 ? tVal: fVal
}



function templateIt(context, template) {
  const script = new vm.Script('`'+template+'`')
  return script.runInNewContext({context, fns:{getDOW, gt0 }})
}

console.log(templateIt(context, template))

https://repl.it/IdVt/3

Answer 15

这个解决方案在没有 ES6 的情况下也可以工作：

function render(template, opts) {
  return new Function(
    'return new Function (' + Object.keys(opts).reduce((args, arg) => args += '\'' + arg + '\',', '') + '\'return `' + template.replace(/(^|[^\\])'/g, '$1\\\'') + '`;\'' +
    ').apply(null, ' + JSON.stringify(Object.keys(opts).reduce((vals, key) => vals.push(opts[key]) && vals, [])) + ');'
  )();
}

render("hello ${ name }", {name:'mo'}); // "hello mo"

注意：Function 构造函数总是在全局范围内创建，这可能会导致全局变量被模板覆盖，例如render("hello ${ someGlobalVar = 'some new value' }", {name:'mo'});

Answer 16

你应该试试这个来自 github 的 Andrea Giammarchi 的微型 JS 模块： https://github.com/WebReflection/backtick-template

/*! (C) 2017 Andrea Giammarchi - MIT Style License */
function template(fn, $str, $object) {'use strict';
  var
    stringify = JSON.stringify,
    hasTransformer = typeof fn === 'function',
    str = hasTransformer ? $str : fn,
    object = hasTransformer ? $object : $str,
    i = 0, length = str.length,
    strings = i < length ? [] : ['""'],
    values = hasTransformer ? [] : strings,
    open, close, counter
  ;
  while (i < length) {
    open = str.indexOf('${', i);
    if (-1 < open) {
      strings.push(stringify(str.slice(i, open)));
      open += 2;
      close = open;
      counter = 1;
      while (close < length) {
        switch (str.charAt(close++)) {
          case '}': counter -= 1; break;
          case '{': counter += 1; break;
        }
        if (counter < 1) {
          values.push('(' + str.slice(open, close - 1) + ')');
          break;
        }
      }
      i = close;
    } else {
      strings.push(stringify(str.slice(i)));
      i = length;
    }
  }
  if (hasTransformer) {
    str = 'function' + (Math.random() * 1e5 | 0);
    if (strings.length === values.length) strings.push('""');
    strings = [
      str,
      'with(this)return ' + str + '([' + strings + ']' + (
        values.length ? (',' + values.join(',')) : ''
      ) + ')'
    ];
  } else {
    strings = ['with(this)return ' + strings.join('+')];
  }
  return Function.apply(null, strings).apply(
    object,
    hasTransformer ? [fn] : []
  );
}

template.asMethod = function (fn, object) {'use strict';
  return typeof fn === 'function' ?
    template(fn, this, object) :
    template(this, fn);
};

演示（以下所有测试都返回 true）：

const info = 'template';
// just string
`some ${info}` === template('some ${info}', {info});

// passing through a transformer
transform `some ${info}` === template(transform, 'some ${info}', {info});

// using it as String method
String.prototype.template = template.asMethod;

`some ${info}` === 'some ${info}'.template({info});

transform `some ${info}` === 'some ${info}'.template(transform, {info});

Answer 17

我制作了自己的解决方案，将类型描述为函数

export class Foo {
...
description?: Object;
...
}

let myFoo:Foo = {
...
  description: (a,b) => `Welcome ${a}, glad to see you like the ${b} section`.
...
}

然后这样做：

let myDescription = myFoo.description('Bar', 'bar');

Answer 18

因为我们正在重新发明轮子，这将是 javascript 中一个可爱的功能。

我使用eval()，它不安全，但javascript 不安全。我欣然承认我在 javascript 方面并不出色，但我有需要，我需要一个答案，所以我做了一个。

我选择使用@ 而不是$ 对我的变量进行样式化，特别是因为我想使用文字的多行特性而不评估直到它准备好。所以变量语法是@{OptionalObject.OptionalObjectN.VARIABLE_NAME}

我不是 javascript 专家，所以我很乐意听取改进建议，但是...

var prsLiteral, prsRegex = /\@\{(.*?)(?!\@\{)\}/g
for(i = 0; i < myResultSet.length; i++) {
    prsLiteral = rt.replace(prsRegex,function (match,varname) {
        return eval(varname + "[" + i + "]");
        // you could instead use return eval(varname) if you're not looping.
    })
    console.log(prsLiteral);
}

下面是一个非常简单的实现

myResultSet = {totalrecords: 2,
Name: ["Bob", "Stephanie"],
Age: [37,22]};

rt = `My name is @{myResultSet.Name}, and I am @{myResultSet.Age}.`

var prsLiteral, prsRegex = /\@\{(.*?)(?!\@\{)\}/g
for(i = 0; i < myResultSet.totalrecords; i++) {
    prsLiteral = rt.replace(prsRegex,function (match,varname) {
        return eval(varname + "[" + i + "]");
        // you could instead use return eval(varname) if you're not looping.
    })
    console.log(prsLiteral);
}

在我的实际实现中，我选择使用@{{variable}}。再来一组牙套。出乎意料地不太可能遇到这种情况。正则表达式看起来像/\@\{\{(.*?)(?!\@\{\{)\}\}/g

为了便于阅读

\@\{\{    # opening sequence, @{{ literally.
(.*?)     # capturing the variable name
          # ^ captures only until it reaches the closing sequence
(?!       # negative lookahead, making sure the following
          # ^ pattern is not found ahead of the current character
  \@\{\{  # same as opening sequence, if you change that, change this
)
\}\}      # closing sequence.

如果您没有使用正则表达式的经验，一个非常安全的规则是转义每个非字母数字字符，并且不要永远不必要地转义字母，因为许多转义字母对几乎所有人都有特殊含义正则表达式的味道。

Answer 19

我意识到我迟到了，但你可以：

const a =  (b) => `b:${b}`;

let b = 10;
console.log(a(b)); // b:10