FLASK 全局模板函数创建以及使用方法来构建资源链接器

代码位置:  app.py

'''
函数模板
'''
from common.libs.UrlManager import UrlManager
app.add_template_global(UrlManager.buildStaticUrl, 'buildStaticUrl')
app.add_template_global(UrlManager.buildUrl, 'buildUrl')
app.add_template_global(UrlManager.buildImageUrl, 'buildImageUrl')

在这段代码中，我们看到了几个关键的操作，它们都与在 Flask 应用中注册全局模板函数有关。这里解释一下每个操作的含义和作用：

1. 导入 UrlManager：

   from common.libs.UrlManager import UrlManager

   
   这行代码从 common.libs 包的 UrlManager 模块中导入了 UrlManager 类。这个类很可能是用于管理URL的，比如构建静态文件URL、普通页面URL和图片URL等。

2. 注册全局模板函数：

   app.add_template_global(UrlManager.buildStaticUrl, 'buildStaticUrl')  
   app.add_template_global(UrlManager.buildUrl, 'buildUrl')  
   app.add_template_global(UrlManager.buildImageUrl, 'buildImageUrl')

   这三行代码将 UrlManager 类中的三个静态方法（或类方法，取决于其定义）注册为 Flask 应用的全局模板函数。这意味着，一旦这些函数被注册，你就可以在 Flask 应用的模板文件（通常是 HTML 文件）中直接使用它们，而无需传递它们作为上下文（context）的一部分。

   • UrlManager.buildStaticUrl 被注册为 buildStaticUrl，允许模板直接调用它来构建静态文件的URL。
   • UrlManager.buildUrl 被注册为 buildUrl，允许模板直接调用它来构建普通页面的URL。
   • UrlManager.buildImageUrl 被注册为 buildImageUrl，允许模板直接调用它来构建图片的URL。

为什么要注册全局模板函数？

注册全局模板函数可以让模板代码更加简洁和易于维护。例如，如果你想在模板中引用一个静态文件（如CSS文件或JavaScript文件），你可以直接使用 {{ buildStaticUrl('path/to/file') }} 来生成正确的URL，而不是在视图函数中手动构建这个URL并将其传递给模板。这样做的好处是模板逻辑与业务逻辑分离，模板变得更加灵活和可重用。

注意事项：

• 确保 UrlManager 类中的这些方法（buildStaticUrl、buildUrl、buildImageUrl）是静态方法或类方法，因为它们被直接引用而不是通过类的实例。
• 这种方法注册的全局模板函数不需要参数 self 或 cls（如果是类方法的话，应该使用 @classmethod 装饰器，并且第一个参数是 cls）。
• Flask 应用实例 app 必须已经创建，并且这些注册操作通常放在应用的初始化代码中。

add_template_global

API — Flask 0.10.1 文档

模板函数详情代码

# -*- coding: utf-8 -*-
import time
from app import app
class UrlManager(object):
    def __init__(self):
        pass

    @staticmethod
    def buildUrl( path ):
        return path

    @staticmethod
    def buildStaticUrl(path):
        release_version = app.config.get( 'RELEASE_VERSION' )
        ver = "%s"%( int( time.time() ) ) if not release_version else release_version
        path =  "/static" + path + "?ver=" + ver
        return UrlManager.buildUrl( path )

    @staticmethod
    def buildImageUrl( path ):
        app_config = app.config['APP']
        url = app_config['domain'] + app.config['UPLOAD']['prefix_url'] + path
        return url

全局模板函数使用案例

某html文件中直接使用

<li class="nav-header">
                    <div class="profile-element text-center">
                        <img alt="image" class="img-circle" src="{{ buildStaticUrl('/images/common/logo.png') }}"/>
                        <p class="text-muted">墨溪泷泉</p>
                    </div>
                    <div class="logo-element">
                        <img alt="image" class="img-circle" src="{{ buildStaticUrl('/images/common/logo.png') }}"/>
                    </div>
                </li>