How to elegantly handle null or undefined variables returned by the database in AnQiCMS templates to avoid page errors?

During the development of website templates, we often encounter a headache: when the data obtained from the database is empty (null) or a variable is undefined in a particular situation, the template rendering will cause an error, resulting in the page not displaying normally and greatly reducing the user experience.AnQiCMS, based on its powerful Go language backend and flexible Django-style template engine, provides us with a variety of elegant solutions for handling such situations, allowing the template to run smoothly even when the data is incomplete.

Use conditional judgment well:{% if %}Tag

The most direct and most commonly used method is to check whether a variable exists or its value is valid through conditional judgment. In AnQiCMS templates, we can use the familiar{% if ... %}/{% elif ... %}and{% else ... %}Build flexible logic with structure.

When we need to check if a variable has a value, we can directly place it in.ifIn the statement. For example, if an article's summary (Description) may be empty, we can handle it like this:

{% if archive.Description %}
    <p>{{ archive.Description }}</p>
{% else %}
    <p>抱歉，暂无摘要信息。</p>
{% endif %}

For the list data returned from the database, we often need to judge whether the list is empty. AnQiCMS provides{% for %}a loop that{% empty %}tag, making it extremely concise to handle an empty list.

{% archiveList archives with type="list" limit="10" %}
    {% for item in archives %}
        <li><a href="{{item.Link}}">{{item.Title}}</a></li>
    {% empty %}
        <li>暂时没有相关文章。</li>
    {% endfor %}
{% endarchiveList %}

WhenarchivesWhen the list is empty, the template will not display an empty<ul>label, but will output directly<li>暂时没有相关文章。</li>to avoid the feeling of emptiness on the page.

II. Provide alternative solutions for variables:defaultanddefault_if_noneFilter

In some cases, we do not want to output empty values or blanks, but provide a default alternative text, for which you can use the built-in AnQiCMS.defaultanddefault_if_noneFilters. They can provide a default value for variables that may be empty or undefined, avoiding direct output of empty content or triggering errors.

• defaultFilterWhen a variable evaluates to a 'false' value (such as an empty string""numbers0and a boolean valuefalseor,nil)defaultThe filter will provide a specified value.

  <h1>{{ archive.Title|default:"无标题文章" }}</h1>
  <p>作者：{{ authorName|default:"匿名用户" }}</p>
  

  Ifarchive.TitleIt is an empty string, orauthorNameUndefined, they will respectively display 'No title article' and 'Anonymous user'.

• default_if_noneFilterThis filter is more focused on processing the Go language in.nil(equivalent to null in other languages) value. It will only apply the default value when the variable is exactlynil. If the variable is an empty string or 0, it will not take effect.

  <p>联系电话：{{ contact.Cellphone|default_if_none:"暂无联系方式" }}</p>
  

  Ifcontact.CellphoneThis variable's value isnilIf there is no contact information displayed.contact.CellphoneIs an empty string""It will directly display an empty string. Choose which filter to use depending on the specific 'empty' state you expect to handle.

Three, ensure content safety and format:safeFilter

Although it does not directly handle null values, when the content returned by the database may contain HTML tags (such as content stored in rich text editors),safeThe filter is crucial for avoiding page errors and ensuring correct content rendering.The AnQiCMS template, for security reasons, defaults to escaping all output to prevent cross-site scripting (XSS) attacks.If you need to output HTML content without being escaped, you must usesafeFilter:

<div>
    {# archive.Content通常包含HTML内容，需要safe过滤器 #}
    {{ archive.Content|safe }}
</div>

If not added|safeHTML tags will be output as is, rather than parsed by the browser, which may affect page layout and content display.

4. Declare variables in advance:{% set %}and{% with %}Tag

When dealing with complex logic or in specific areas of the template where temporary storage of calculation results is needed, it is a good habit to declare variables in advance.This can avoid problems caused by undefined variables in subsequent code.

• {% set %}Tag: Used to define a new variable within the current template scope.

  {% set articleCount = archives|length %}
  <p>本分类共有 {{ articleCount }} 篇文章。</p>
  

• {% with %}Tag: Mainly used for.{% include %}The template fragment passes local variables, or defines temporary variables within a specific logic block. The variables defined are only available within{% with %}to{% endwith %}.

  {% with featuredArticle=archives|first %}
      {% if featuredArticle %}
          <h2>今日推荐：{{ featuredArticle.Title }}</h2>
      {% endif %}
  {% endwith %}
  

  here,featuredArticlevariables are onlywiththe block, avoiding pollution of global variables or unexpected side effects.

By flexibly applying these techniques, you can handle various situations of null or undefined variables returned by the database in AnQiCMS templates, making your website not only powerful but also excellent in stability and user experience.

Frequently Asked Questions (FAQ)

1. defaultanddefault_if_noneWhat are the differences between filters, and when should I use them? defaultFilters provide a default value when the variable is "false" (includingnilan empty string""numbers0and a boolean valuefalse). While thedefault_if_nonefilter is more strict, it only applies when the variable is exactly equal tonilOnly when a default value is provided, if the variable is an empty string or other 'false' value, it will not take effect.

   • If you want to provide a universal default value for all types of 'empty' values (including undefined, empty strings, zero, etc.), usedefault.
   • If you need to distinguishnilAnd other "empty" values (for example, a field explicitly not set is different from a field set to an empty value), or a variable may be a pointer but not initialized, thendefault_if_noneIs a more precise choice.

2. Why is it still possible to see the word 'nil' on the page even though these methods were used?This usually happens in the following situations:

   • You have useddefaulta filter, but the value of the variable is notnilIt is a pointer, notnilof type (for example,*stringa variable of type, with the valuenil), or an empty structure, etc. At thisdefaultit may not be considered a 'false' value.
   • You are trying to directly output anilvariable for the value, but forget to usedefault_if_noneorifa statement for judgment. In Go language,nilThe value is usually displayed as "nil" when output directly in the template.
   • The variable is not truly undefined or empty, but rather one of its nested fields is empty ornil. But you accessed the outer variable directly. At this point, you need to further check and judge the nested fields.

3. In the loop, besidesemptyTags, how can I handle more complex null value situations? {% for ... empty %}The structure is very suitable for providing default content when the list is empty. If your 'empty value situation' involves each element in the loop body having a specific field that may be empty, or if you need to control the data in the loop more finely, you can combine the use ofifanddefaultFilter. For example, you can use it in each loop.itemAgain inside.{% if item.field %}or{{ item.field|default:"默认值" }}Come handle the empty value of a single element. In addition, if the elements in the list are complex types, consider preprocessing the data at the Go backend code level before passing it to the template to ensure the integrity and consistency of the data.