将Django模板变量传递给外部JS调用的几种方式

Roy
编程技术

最近一直在思考如何更好的组织Django中的静态资源，比如JS、CSS一类，如何结合前端构建工具写出更好的代码以及结构呢？

首先需要解决的一个问题就是某些时候需要把JS代码写在模板里来获取后台传递过来的变量，比如：

<div>
<h1>Test</h1>
<div id="my-test" ></div>
</div>
<script>
$(function(){
  $('#my-test').html("{{ some_var_from_view }}")
});
</script>

这么写代码的话，别扭不说，前端的那些构建工具比如webpack，gulp的使用范围也将大大降低。

首先说结论，想完全剥离JS和模板而又需要使用模板渲染的数据，我是没想到什么好办法。如果读者有好办法希望赐教。 既然不能完全剥离，那么就进最大的努力分离JS所需的数据和代码吧。

既然需要模板渲染数据给JS使用，最先想到的办法就是把数据渲染到HTML代码中并隐藏。这种方法的优点就在于简单，甚至模板中都可以完全不使用<script></script>标签。缺点则是会渲染出很多的隐藏字段，JS中要写大量的getElementsByxxxx一类的代码来获取数据。

既然如此，那么使用一种折中的办法，在HTML中使用<script></script>标签将后台传递的数据渲染成JS对象，然后JS代码中则可以直接使用这个对象了。比如模板中：

<script>
var MyViewVar = {
  var_1: {{ var_1 }},
  var_2: {{ var_2 }},
};
</script>


...

<script type="text/javascript" src="/js/test_script.js"></script>

使用这种方式需要注意一点就是尽量先写渲染JS变量的代码，比如写在head中，然后再引入外部JS文件。这样，在test_script.js中就可以直接使用MyViewVar这个对象了。

当然了，既然现在流行SPA（Single Page Application）网站，那么django作为后端仅提供JSON数据也是一种办法，不过这样比较考验前端人员的能力了。