# sql-parser

**Repository Path**: liuzhixing/sql-parser

## Basic Information

- **Project Name**: sql-parser
- **Description**: sql-parser解释器，结合freemarker模板解释器，加上自定义一套参数解释标准，让开发更简单
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 3
- **Created**: 2023-11-12
- **Last Updated**: 2023-11-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# sql-parser

#### 介绍
sql-parser解释器，结合freemarker模板解释器，加上自定义一套参数解释标准，让开发更简单

#### 安装教程

1. 配置仓库地址

```xml
  <repository>
       <id>pesking_public</id>
       <name>pesking_public</name>
       <url>http://www.peskingsoft.com/repository/internal</url>
       <releases>
           <enabled>true</enabled>
       </releases>
       <snapshots>
           <enabled>true</enabled>
       </snapshots>
   </repository>
```

2. 引入包

   ```xml
   <properties>
           <pesking.sql-parser.version>1.0-SNAPSHOT</pesking.sql-parser.version>
   </properties>
   <dependency>
   	<groupId>com.pesking.framework</groupId>
   	<artifactId>sql-parser</artifactId>
   	<version>${pesking.sql-parser.version}</version>
   </dependency>
   ```

   

#### 使用说明

1. 使用方法

   1.  无参数情况的使用方法

       1) 在reosurces/config/sql里建一个sql文件(示例：resources/config/sql/test/testQuery.sql),所有的SQL必须放在resources/config/sql目录下，可以放在子目录下

       ```
       select * from sys_dept
       ```

       SQL语句编写按正常SQL语法写法

       2. 代码调用

       ```
       List<Map<String,String>> result = SqlParserManage.toMapListById("test/testQuery");
       System.out.println("SQL查询输出结果->" + JSON.toJSONString(result));
       ```

       如果使用自定义的类接收，可以使用下列代码

       ```
       SysDept objectResult = SqlParserManage.toObjectById("test/outputObject",SysDept.class);
       System.out.println("SQL查询输出对象结果->" + JSON.toJSONString(objectResult));
       ```

       注意：

       a. SQL里输出的字段名必须跟类的属性对应，大小写无关，系统会全部转化为小写进行比较，然后赋值

       b. 上述语句如果查询出多条记录，系统默认取第一条记录

   2.  有参数情况的使用方法

       1. SQL写法

          ```
          select dept_id,
          		dept_name
          from sys_dept
          where 1 = 1
          <#if deptName?? && deptName != ''>
          	and dept_name like [AV:deptName]
          </#if>
          ```

          <#if是freemarker模板语法，语法详情见下述freemarker语法说明，如果deptName不能为空时就增加参数 dept_name条件

       2. 代码调用

          ```
           Parameter parameter = new Parameter();
           parameter.setParameter("deptName","test");
           objectResult = SqlParserManage.toObjectById("test/outputObject",parameter,SysDept.class);
           System.out.println("SQL查询输出对象结果->" + JSON.toJSONString(objectResult));
          ```

          如果是参数是一个对象，可以下列方法转化为parameter对象

          ```
          SysDept dept = new SysDept();
          dept.setDeptName("test");
          Parameter parameter = SqlParserManager.toParameter(dept);
          ```

          

2. ##### 调用接口说明

   

3. ##### SQL编写说明

   

4. ##### 自定义参数说明

   

5. ##### freemarker模板使用说明

   Freemarker是一款 模板引擎：即一种基于模板和要改变的数据，并用来生成输出文本(HTML网页，电子邮件，配置文件，源代码等)的通用工具。它不是面向最终用户的，而是一个Java类库，是一款程序员可以嵌入他们所开发产品的组件。

   **Freemarker基础语法种类**

   1、注释，即<#-- -->，介于其之间的内容会被freemarker忽略

   ```text
   <#--我是一个freemarker注释-->
   ```

   2、插值(Interpolation)：即${..}部分,freemarker会用真实的值代替${..}

   ```text
   Hello ${name}
   ```

   3、FTL指令：和HTML标记类似，名字前加#予以区分，Freemarker会解析标签中的表达式或逻辑。

   ```text
   <# >FTL指令</#>
   ```

   4、文本，仅文本信息，这些不是freemarker的注释、插值、FTL指令的内容会被freemarker忽略解析，直接输出内容。

   ```text
   <#--freemarker中的普通文本-->
   我是一个普通的文本
   ```

   **集合指令-List**

   集合指令List的指令格式如下：

   ```text
   <#list></#list>
   ```

   例子：

   ```text
   <#list stus as stu>
      <tr>
         <td>${stu_index+1}</td>
         <td>${stu.name}</td>
         <td>${stu.age}</td>
         <td>${stu.money}</td>
      </tr>
   </#list>
   ```

   ${k_index}：得到循环的下标，使用方法是在stu后边加"_index"，它的值是从0开始。

   **集合指令-Map**

   1.获取map中的值

   ```text
   map['keyname'].property
   map.keyname.property
   ```

   2.遍历map

   ```text
   <#list userMap?keys as key>
       key:${key}--value:${userMap["${key}"]}
   </#list>
   ```

   if指令

   if指令的语法格式如下：

   ```text
   <#if expression>
   <#else>
   </#if>
   ```

   需求：在list集合中判断学生为小红的数据字体显示为红色。

   ```text
   <#if stu.name='小红'>
      <tr style="color: red">
          <td>${stu_index}</td>
          <td>${stu.name}</td>
          <td>${stu.age}</td>
          <td>${stu.money}</td>
      </tr>
   <#else >
      <tr>
      <td>${stu_index}</td>
      <td>${stu.name}</td>
      <td>${stu.age}</td>
      <td>${stu.money}</td>
   </tr>
   </#if>
   ```

   在freemarker中，判断是否相等，=与==是一样的。

   FreeMarker表达式中完全支持算术运算,FreeMarker支持的算术运算符包括:

   ①加法：+

   ②减法：-

   ③乘法：*

   ④除法：/

   ⑤求模(求余)：%

   常见的比较运算符，和它们用途说明如下表：

   

   ![img](https://pic4.zhimg.com/80/v2-0ca6c88b049652a56d5a42d0a4cb37d7_720w.webp)

   

   注意事项：=和!=可以用于字符串、数值和日期来比较是否相等

   =和!=两边必须是相同类型的值,否则会产生错误字

   符串"x"、"x "、"X"比较是不等的.因为FreeMarker是精确比较

   gt代替>, FreeMarker会把>解释成FTL标签的结束字符,可使用括号避免这种情况,如:<#if (x>y)>

   **空值处理**

   1、判断某变量是否存在使用"??"用法为:variable??,如果该变量存在,返回true,否则返回false。

   例：为防止stus为空报错可以加上判断如下：

   ```text
   <#if stus??>
      <#list stus as stu>
          ......
      </#list>
   </#if>
   ```

   2、缺失变量默认值使用"!"

   使用!要以指定一个默认值，当变量为空时显示默认值,例如${name!''}表示如果name为空显示空字符串。

   如果是嵌套对象则建议使用()括起来,例如${(stu.name)!''}表示，如果stu或name为空默认显示空字符串。

   **内建函数**

   内建函数语法格式：变量+?+函数名称
   1.集合的大小。

   ```text
   ${集合名?size}
   ```

   2.日期格式化

   ```text
   显示年月日: ${today?date}
   显示时分秒：${today?time}
   显示日期+时间：${today?datetime}
   自定义格式化：${today?string("yyyy年MM月")}
   ```

   3.内建函数c

   ```text
   model.addAttribute("point", 102920122);
   ```

   point是数字型，使用${point}会显示这个数字的值，每三位使用逗号分隔。如果不想显示为每三位分隔的数字，可以使用c函数将数字型转成字符串输出。

   ```text
   ${point?c}
   ```

   4.将json字符串转成对象

   一个例子：其中用到了assign标签，assign的作用是定义一个变量。

   ```text
   <#assign text="{'bank':'工商银行','account':'10101920201920212'}" />
   <#assign data=text?eval />
   开户行：${data.bank}账号：${data.account}
   ```