Django 重用 javascript 代码的最佳实践

     2023-02-24     210

关键词:

【中文标题】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/等,并将其作为静态资源提供。

【讨论】:

谢谢!这就是我一直在寻找的。我知道有一种“优雅”的方式可以做到这一点;)

javascript样本组件重用react(代码片段)

查看详情

javascript使用捕获组重用模式(代码片段)

查看详情

django项目一:基于django2.2可重用登录与注册模块-django表单(代码片段)

...的方式,其效率和正确性都将无法得到保证,有鉴于此,Django在内部集成了一 查看详情

我可以从 C#(Windows 服务)执行/重用 javascript 代码吗?

】我可以从C#(Windows服务)执行/重用javascript代码吗?【英文标题】:CaniExecute/reusejavascriptcodefromC#(windowsservice)[duplicate]【发布时间】:2016-12-1022:15:05【问题描述】:我有一个在客户端运行的javascript代码(业务逻辑),我希望从wi... 查看详情

创建可重用的 Django 应用程序?

】创建可重用的Django应用程序?【英文标题】:CreatingReusableDjangoApps?【发布时间】:2011-08-2223:15:56【问题描述】:我有点像Django初学者,并且一直在尝试尽可能地解耦我的应用程序,并将其构建成尽可能小的可重用部分。试图遵... 查看详情

创建一个包含一些组件的 Javascript 包以供重用

】创建一个包含一些组件的Javascript包以供重用【英文标题】:CreatingaJavascriptbundlewithafewcomponentsforreuse【发布时间】:2021-01-0121:23:36【问题描述】:我有一个后端渲染页面(如果它重要的话是django),我想使用PrimeVue中的一些组件... 查看详情

javascript使用此关键字使代码更可重用(代码片段)

查看详情

如何编写重用通用 JavaScript 代码的反应原生“本机模块”(桥)?

】如何编写重用通用JavaScript代码的反应原生“本机模块”(桥)?【英文标题】:Howtowritereactnative"nativemodule"(bridge)thatreusescommonJavaScriptcode?【发布时间】:2017-11-0115:52:07【问题描述】:原生模块如何回调到JavaScript内部桥... 查看详情

Django 可重用查询集

】Django可重用查询集【英文标题】:DjangoResuableQuerySet【发布时间】:2012-12-1202:01:25【问题描述】:我在如下视图中有一个QuerySet。我希望能够在其他视图中使用相同的查询,但我不想复制和粘贴代码。这也感觉我会违反DRY原则。... 查看详情

如何在 Django 中重用可重用的应用程序

】如何在Django中重用可重用的应用程序【英文标题】:Howtore-useareusableappinDjango【发布时间】:2010-10-0802:46:20【问题描述】:我正在尝试在Django中创建我的第一个网站,并且在寻找示例应用程序以从中汲取灵感时,我经常偶然发... 查看详情

django项目一:基于django2.2可重用登录与注册模块-admin后台(代码片段)

...试环境,为了测试和开发的方便,通常我们会频繁的使用Django给我们提供的Admin后台管理页面,创建测试用例,观察模效果等。一.在admin中注册模型admin后台本质上是Django给我们提供的一个app,默认情况下,他已经在settings中注册... 查看详情

为啥我的链表代码在模块化可重用 JavaScript 函数中不起作用?

】为啥我的链表代码在模块化可重用JavaScript函数中不起作用?【英文标题】:WhydoesmylinkedlistcodenotworkinamodularreusableJavaScriptfunction?为什么我的链表代码在模块化可重用JavaScript函数中不起作用?【发布时间】:2022-01-1312:19:23【问题... 查看详情

django-在多个页面上重用用户注册表单的系统架构(代码片段)

我正在想办法如何重复使用相同的注册表单并查看多个模板和页面,以及不同的格式。例如。在页面上,在一个模态等。然而,我在找出解决这个问题的最佳实践方面遇到了一些麻烦。我正在积极避免的一件事就是重复自己,但... 查看详情

为可重用的 Django 应用程序创建迁移

】为可重用的Django应用程序创建迁移【英文标题】:CreatingmigrationsforareusableDjangoapp【发布时间】:2019-06-1901:27:20【问题描述】:我正在编写一个可重用的Django应用程序,但在创建迁移时遇到了问题。我看过thisquestion,我还是一头... 查看详情

django项目一:基于django2.2可重用登录与注册模块-数据模型设计(代码片段)

前言使用Django开发Web应用的过程中,很多人都是急忙斜视图,写前端页面,把最根本的模型设计给忽略了。模型中定义了数据如何在数据库内保存,也就是数据表的定义方式,这部分工作体现在Django的代码中,其实就是model类的... 查看详情

我想在 Django 中创建一个可重用的函数

】我想在Django中创建一个可重用的函数【英文标题】:IwanttocreateareusablefunctioninDjango【发布时间】:2018-03-0210:48:03【问题描述】:我是django的新手,并且一直在从事一个项目,我需要从我的django项目中的不同模块定期向我的客户... 查看详情

如何为 django 可重用应用程序启动测试?

】如何为django可重用应用程序启动测试?【英文标题】:Howtolaunchtestsfordjangoreusableapp?【发布时间】:2011-04-1923:53:25【问题描述】:我可以在不将该应用程序合并到项目中的情况下为我的可重用Django应用程序启动测试吗?我的应... 查看详情

如何在zapier中重用javascript函数

】如何在zapier中重用javascript函数【英文标题】:Howtoreusejavascriptfunctionsinzapier【发布时间】:2021-03-1418:21:33【问题描述】:我有一个更大的网络,其中包含数百个通过webhook连接的zaps。他们都在使用运行javascript函数的代码步骤来... 查看详情