Interface Template

All Known Implementing Classes:
Template.Default, Templates
public interface Template
模板接口。

模板是可信 SQL 片段，使用 {} 占位；框架不做注入校验。模板参数在 WHERE/ON 等 条件中会绑定为 ?，在 SELECT 列表中会被当作字面量。 禁止将终端用户输入作为模板内容。

Author:
Maning

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final record 
    Template.Default
    Template默认实现

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    FUNCTION_PRECEDENCE
    函数默认优先级最高

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    name()
    模板名称,一般不需要,返回null即可,内置模板会有名称,方便被方言覆写
    static Template
    of(String template)
    从字符串获取模板。
    default int
    precedence()
    优先级,越大越优先,作用于操作符
    String
    template()
    模板内容,使用{}代表参数占位

  • Field Details

    • FUNCTION_PRECEDENCE

      static final int FUNCTION_PRECEDENCE
      函数默认优先级最高
      See Also:

  • Method Details

    • of

      static Template of(String template)
      从字符串获取模板。

      模板内容必须是可信 SQL 片段，禁止拼接终端用户输入。

      Parameters:
      template - 模板
      Returns:
      模板

    • name

      default String name()
      模板名称,一般不需要,返回null即可,内置模板会有名称,方便被方言覆写
      Returns:
      模板名称

    • precedence

      default int precedence()
      优先级,越大越优先,作用于操作符
      Returns:
      优先级

    • template

      String template()
      模板内容,使用{}代表参数占位
      Returns:
      模板