Django 重用 javascript 代码的最佳实践
Posted
技术标签:
【中文标题】Django 重用 javascript 代码的最佳实践【英文标题】：Django best practice for reusing javascript code 【发布时间】：2015-12-29 20:21:33 【问题描述】：我有两个外部库（jQuery X-editable 和 FineUploader）需要的 javascript 代码，我需要我的上下文变量。因此，我不能为这些代码使用外部 js。
这是我目前在模板上所做的：
some_important_template.html
% include "includes/editable_fields.html" %
% include "includes/fine_upload_template.html" %
fine_upload_template.html
<script type="text/template" id="qq-template">
<div class="qq-uploader-selector qq-uploader" qq-drop-area-text="Drop files here">
<div class="qq-total-progress-bar-container-selector qq-total-progress-bar-container">
<div role="progressbar" aria-valuenow="0" aria-valuemin="0" aria-valuemax="100" class="qq-total-progress-bar-selector qq-progress-bar qq-total-progress-bar"></div>
</div>
<div class="qq-upload-drop-area-selector qq-upload-drop-area" qq-hide-dropzone>
<span class="qq-upload-drop-area-text-selector"></span>
</div>
<div class="qq-upload-button-selector btn btn-info">
<div>Upload a file</div>
</div>
<span class="qq-drop-processing-selector qq-drop-processing">
<span>Processing dropped files...</span>
<span class="qq-drop-processing-spinner-selector qq-drop-processing-spinner"></span>
</span>
<ul class="qq-upload-list-selector qq-upload-list" aria-live="polite" aria-relevant="additions removals">
<li>
<div class="qq-progress-bar-container-selector">
<div role="progressbar" aria-valuenow="0" aria-valuemin="0" aria-valuemax="100" class="qq-progress-bar-selector qq-progress-bar"></div>
</div>
<span class="qq-upload-spinner-selector qq-upload-spinner"></span>
<img class="qq-thumbnail-selector" qq-max-size="100" qq-server-scale>
<span class="qq-upload-file-selector qq-upload-file"></span>
<span class="qq-edit-filename-icon-selector qq-edit-filename-icon" aria-label="Edit filename"></span>
<input class="qq-edit-filename-selector qq-edit-filename" tabindex="0" type="text">
<span class="qq-upload-size-selector qq-upload-size"></span>
<button type="button" class="qq-btn qq-upload-cancel-selector btn btn-danger">Cancel</button>
<button type="button" class="qq-btn qq-upload-retry-selector btn btn-info">Retry</button>
<button type="button" class="qq-btn qq-upload-delete-selector qq-upload-delete">Delete</button>
<span role="status" class="qq-upload-status-text-selector qq-upload-status-text"></span>
</li>
</ul>
<dialog class="qq-alert-dialog-selector">
<div class="qq-dialog-message-selector"></div>
<div class="qq-dialog-buttons">
<button type="button" class="qq-cancel-button-selector">Close</button>
</div>
</dialog>
<dialog class="qq-confirm-dialog-selector">
<div class="qq-dialog-message-selector"></div>
<div class="qq-dialog-buttons">
<button type="button" class="qq-cancel-button-selector">No</button>
<button type="button" class="qq-ok-button-selector">Yes</button>
</div>
</dialog>
<dialog class="qq-prompt-dialog-selector">
<div class="qq-dialog-message-selector"></div>
<input type="text">
<div class="qq-dialog-buttons">
<button type="button" class="qq-cancel-button-selector btn btn-danger">Cancel</button>
<button type="button" class="qq-ok-button-selector btn btn-info">Ok</button>
</div>
</dialog>
</div>
</script>
<script>
var uploader = new qq.FineUploader(
debug: true,
element: document.getElementById('fine-uploader'),
request:
endpoint: '% url "registrations:ajax_upload" registration.pk %',
params:
'csrfmiddlewaretoken': ' csrf_token '
,
deleteFile:
enabled: false,
endpoint: '/uploads'
,
retry:
enableAuto: false
);
</script>
editable_fields.html
<script>
//turn to inline mode
$.fn.editable.defaults.mode = 'inline';
% if registration.emergency_contact %
$('#contact_first_name').editable(
name: 'first_name',
pk: registration.emergency_contact.id,
url: '% url "profiles:field_inline" %',
params: "csrfmiddlewaretoken:'csrf_token', model: 'User'"
);
$('#contact_last_name').editable(
name: 'last_name',
pk: registration.emergency_contact.id,
url: '% url "profiles:field_inline" %',
params: "csrfmiddlewaretoken:'csrf_token', model: 'User'"
);
% endif %
% for parent in registration.tutors.all %
$('#parent_first_name_ forloop.counter ').editable(
name: 'first_name',
pk: parent.id,
url: '% url "profiles:field_inline" %',
params: "csrfmiddlewaretoken:'csrf_token', model: 'User'"
);
$('#parent_last_name_ forloop.counter ').editable(
name: 'last_name',
pk: parent.id,
url: '% url "profiles:field_inline" %',
params: "csrfmiddlewaretoken:'csrf_token', model: 'User'"
);
% for phone in parent.profile.phone_set.all %
$('#parent_phone_phone.type_forloop.parentloop.counter').editable(
name: 'number',
pk: phone.id,
url: '% url "profiles:field_inline" %',
params: "csrfmiddlewaretoken:'csrf_token', model: 'Phone'"
);
% endfor %
% endfor %
% for phone in registration.emergency_contact.profile.phone_set.all %
$('#contact_phone_phone.type').editable(
name: 'number',
pk: phone.id,
url: '% url "profiles:field_inline" %',
params: "csrfmiddlewaretoken:'csrf_token', model: 'Phone'"
);
% endfor %
% with registration.costumer as costumer %
$('#email').editable(
pk: costumer.id,
url: '% url "profiles:field_inline" %',
params: "csrfmiddlewaretoken:'csrf_token', model: 'User'"
);
$('#first_name').editable(
pk: costumer.id,
url: '% url "profiles:field_inline" %',
params: "csrfmiddlewaretoken:'csrf_token', model: 'User'"
);
$('#last_name').editable(
pk: costumer.id,
url: '% url "profiles:field_inline" %',
params: "csrfmiddlewaretoken:'csrf_token', model: 'User'"
);
$('#birth_date').editable(
pk: costumer.profile.id,
url: '% url "profiles:field_inline" %',
type: 'combodate',
params: "csrfmiddlewaretoken:'csrf_token', model: 'Profile'",
);
% with costumer.profile.address as address %
$('#address1').editable(
pk: address.id,
url: '% url "profiles:field_inline" %',
title: 'Enter Address 1',
params: "csrfmiddlewaretoken:'csrf_token', model: 'Address'"
);
$('#address2').editable(
pk: address.id,
url: '% url "profiles:field_inline" %',
title: 'Enter Address 1',
params: "csrfmiddlewaretoken:'csrf_token', model: 'Address'"
);
$('#zip_code').editable(
pk: address.id,
url: '% url "profiles:field_inline" %',
title: 'Enter Zip Code',
params: "csrfmiddlewaretoken:'csrf_token', model: 'Address'"
);
$('#city').editable(
pk: address.id,
url: '% url "profiles:field_inline" %',
title: 'Enter City',
params: "csrfmiddlewaretoken:'csrf_token', model: 'Address'"
);
$('#estate').editable(
pk: address.id,
url: '% url "profiles:field_inline" %',
title: 'Enter State',
params: "csrfmiddlewaretoken:'csrf_token', model: 'Address'"
);
% endwith %
% endwith %
</script>
这可行，但我不确定它是否遵循 Django 最佳实践。
【问题讨论】：
【参考方案1】：将 javascript 和 Django 模板代码结合起来并不是一个好主意。
相反，在您的 javascript 周围编写一个包装函数，该函数接受您的所有模板变量。 IE。创建一个包含以下内容的 javascript 文件：
var wrapper = function (args)
//turn to inline mode
$.fn.editable.defaults.mode = 'inline';
if (args.registration_emergency_contact)
$('#contact_first_name').editable(
name: 'first_name',
pk: args.registration_emergency_contact_id,
url: args.profiles_field_inline,
params: "csrfmiddlewaretoken:'" + args.csrf_token + "', model: 'User'"
);
// ...
在您看来，将 args 创建为 json 值：
def myview(...):
args =
'registration_emergency_contact': bool(registration.emergency_contact),
'registration_emergency_contact_id': registration.emergency_contact.id,
'profiles_field_inline': reverse(...),
// ...
return ... , Context('args': json.dumps(args))..
然后在你的模板文件中，通过脚本标签包含javascript文件并调用函数：
wrapper( args|safe );
这样您的 javascript 只包含 javascript，您可以使用所有可用的 javascript 工具来 lint/minifiy/transpile/等，并将其作为静态资源提供。
【讨论】：
谢谢！这就是我一直在寻找的。我知道有一种“优雅”的方式可以做到这一点；）以上是关于Django 重用 javascript 代码的最佳实践的主要内容，如果未能解决你的问题，请参考以下文章