猿创征文｜实战开发openGauss DataStudio的sql联想结构_datastudio的sql终端(1)

最新推荐文章于 2024-05-15 20:30:52 发布

2301_82241942

最新推荐文章于 2024-05-15 20:30:52 发布

阅读量893

点赞数 22

分类专栏：程序员文章标签： sql 数据库 oracle

本文链接：https://blog.csdn.net/2301_82241942/article/details/138453398

版权

程序员专栏收录该内容

129 篇文章 2 订阅

订阅专栏

前段时间正好完成国产数据库openGauss DataStudio的sql语句表提示功能优化，借此机会来给大家分享一下我的开发过程以及经验。
项目暂时还处于结项阶段，如果大家在中间有更好的解决思路或者经验，非常欢迎大家前来讨论交流😎

实战开发sql语句提示表结构

前情提要
一已完成工作
- 1.1 实现功能
二遇到的问题以及解决方案
- 2.1 安装数据库
  - 2.2 DataStudio的开发环境配置
  - 2.3 开发过程
三后续安排
四总结
后续

前情提要

openGauss社区网址：https://www.opengauss.org/zh/

DataStudio 是openGauss 的官方客户端工具，提供可视化管理 openGauss 数据库；支持管理和创建数据库、模式、表等各类数据库对象；执行SQL语句或脚本，高效进行sql开发；创建和执行sql语句，支持存储过程调试；表数据增、删、改、查操作等功能。Sql 的可视化客户端大大减少了开发人员的开发时间成本，具备简单、安全、逻辑数据独立性等优点。为了使用人员在查询时更加方便，应该将 DataStudio 的功能进行改进，把 sql 输入联想功能进行优化，把当前字联想改为表结构联想，并且为了方便操作数据库时更加方便，添加选择“all”时自动填充所有表结构。本文主要是对于开发功能的介绍以及在开发过程中遇到的问题。

目前PR已经提交了
在这里插入图片描述

关于如何安装openGauss以及启动项目大家可以翻看我之前的博客内容。

一已完成工作

1.1 实现功能

对当前sql输入联想功能进行优化，把当前的关键字联想改为表结构联想，并且在选择“all”时自动填充所有表结构。

当输入一个数据库表再敲一个左括号或英文句号后会展示出所有的数据库表的列以及该列的相关信息；增加一个“all”的选项，当我们选择该字段后，会将该数据库表中所有的列按照id大小将所有的列展示出来。

前提说明：测试表名为students，该表的列有student_id，student_name，department
在这里插入图片描述
效果图如下：

1.2 方案描述

以表列为例。

通过输入的字符串进行切割，判断该值属于哪一范围，如果属于表并且以英文句号结尾的字符串或者以insert into 表名开头并以英文“(”结尾那么就会通过findAllChildObjects查找它的所有子对象，通过查找该表名的类型是否是TableMetaData，如果是那么通过该表名去查找它的子对象也就是列，如果是表元数据的话还会通过contentAssistUtil.getChildObject()该方法增加一个key值为“all”的数据，该数据通过getChildObject()通过依次获取列元数据的值将该值增加到“ColumnAll”类的name属性下。将该值返回到上一层，并通过其他函数进行展示。流程图如下：
在这里插入图片描述

1.3 代码修改

经过前期阅读代码发现，如果要实现我们的功能，修改增加或修改的代码存在于

org.opengauss.mppdbide.bl.serverdatacache中的ColumnMetaData
在该类里增加“all”方法。通过该方法可以通过后续调用将“all”显示在提醒数据上。

private static final String OCP = "all";
/\*\*
 \* Gets the String.
 \*
 \* @param 
 \* @return the string all
 \*/
public String getClms() {
return OCP;
}

org.opengauss.mppdbide.bl.contentassist中的 ContentAssistProcesserData
在该类中需要修改“findAllChildObjects”方法。
当servObj为TableMetaData的时候，我们需要将表自己的拥有的列数据通过found.putAll(tbl.findAllChildObjects());该方法进行加载，还需要加载“all”的值，故需要执行found = contentAssistUtil.getChildObject(found, parentObjMap.size() > 1);将“all”对应的value值添加进去。

/\*\*
 \* Find all child objects.
 \*
 \* @param parentObjMap the parent obj map
 \* @return the sorted map
 \*/
 private SortedMap<String, ServerObject> findAllChildObjects(SortedMap<String, ServerObject> parentObjMap) {
    SortedMap<String, ServerObject> found = new TreeMap<String, ServerObject>(new AutoSuggestComparator());
    for (ServerObject servObj : parentObjMap.values()) {
        if (servObj instanceof GaussOLAPDBMSObject) {
            if (!isInsert() && servObj instanceof Namespace) {
                Namespace ns = (Namespace) servObj;
                found.putAll(ns.findAllChildObjects());
            } else if (servObj instanceof ForeignTable) {
                ForeignTable fTable = (ForeignTable) servObj;
                found.putAll(fTable.findAllChildObjects());
            } else if (servObj instanceof PartitionTable) {
                PartitionTable partitionTable = PartitionTable.class.cast(servObj);
                found.putAll(partitionTable.findAllChildObjects());
            } else if (servObj instanceof TableMetaData) {
                TableMetaData tbl = (TableMetaData) servObj;
                found.putAll(tbl.findAllChildObjects());
                found = contentAssistUtil.getChildObject(found, parentObjMap.size() > 1);
            } else if (servObj instanceof ViewMetaData) {
                 ViewMetaData view = ViewMetaData.class.cast(servObj);
                 found.putAll(view.findAllChildObjects());
            }
        }
        if (isInsert()) {
            found = contentAssistUtil.getChildObject(found, parentObjMap.size() > 1);
        }
        if (!servObj.isLoaded() && nonLoaded != null) {
            nonLoaded.add(servObj);
        }
    }
    return found;
}

org.opengauss.mppdbide.bl.contentassist中的ContentAssistUtilOLAP
在该类中需要修改“getChildObject”方法。
在该方法中我们通过获取found里面的数据（该数据是通过执行上一步中获取的列数据），通过循环遍历，如果是我们需要的值就加入进去。方法主体是通过循环found数据，如果该类型是 ColumnMetaData 类型，那么就将该值加入到resultMap中，同时获得该数据的name，将该值作为一个字符串存储，如果不是found的最后一项，还需要在其后添加上“， ”，当数据加载到最后一项将字符串拼接完整后，创建ColumnAll 类并初始化，该字符串作为ColumnAll 的name保存，将其加入到resultMap值中。这样“all”对应的ServerObject就有了。

@Override
public SortedMap<String, ServerObject> getChildObject(SortedMap<String, ServerObject> found, boolean isParentDescNeeded) {
    SortedMap<String, ServerObject> resultMap = new TreeMap<String, ServerObject>();
    int len = found.size();
    if(isInsert()) {
        len = len - 1;
    }
    StringBuffer clName = new StringBuffer();
    int temp = 0;
    for (ServerObject obj : found.values()) {
        if (obj instanceof ColumnMetaData) {
            ColumnMetaData clm = (ColumnMetaData) obj;
            resultMap.put(clm.getClmNameWithDatatype(isParentDescNeeded), obj);
            
            if(temp < len) {
                clName.append(((ColumnMetaData) obj).getParentTable().getColumnMetaDataList().get(temp).getName());
                if(temp < len - 1) {
                    clName.append(", ");
                }else {
                    ColumnAll ocb = new ColumnAll(temp,clName.toString(),OBJECTTYPE.COLUMN_METADATA, false);
                    resultMap.put(clm.getClms(), ocb);
                }
               temp++;
            }     
        } else if (obj instanceof ViewColumnMetaData) {
            ViewColumnMetaData clm = (ViewColumnMetaData) obj;
            resultMap.put(clm.getClmNameWithDatatype(isParentDescNeeded), obj);
        }
    }
    return resultMap;
}

org.opengauss.mppdbide.bl.serverdatacache.groups中增加一个新的类ColumnAll
该类作为存储“all”的ServerObject存在，也就是当点击“all”时，就会调用该类里的getName方法进行展示。

package org.opengauss.mppdbide.bl.serverdatacache.groups;

import org.opengauss.mppdbide.bl.serverdatacache.OBJECTTYPE;
import org.opengauss.mppdbide.bl.serverdatacache.ServerObject;
import org.opengauss.mppdbide.bl.serverdatacache.groups.ColumnList;
import org.opengauss.mppdbide.utils.IMessagesConstants;
import org.opengauss.mppdbide.utils.loader.MessageConfigLoader;

/\*\*
 \* Title: ColumnAll
 \* Get all the current columns from the table and store them
 \*/

public class ColumnAll extends ServerObject {
    
    private int id;
    private String name;
    

    /\*\*
 \* Instantiates a new ColumnsAll object.
 \*
 \* @param oid the oid
 \* @param name the name
 \* @param type the type
 \* @param privilegeFlag the privilege flag
 \*/
    public ColumnAll(long oid, String name, OBJECTTYPE type, boolean privilegeFlag) {
        super(oid, name, OBJECTTYPE.COLUMN_METADATA, false);
        this.name = name;
    }
    
    public void setName(String name) {
        this.name = name;
    }
    
    public String getName() {
        return name;
    }
    
    public void setId(int id) {
        this.id = id;
    }
    
    public int getId() {
        return id;
    }
   
}

在org.opengauss.mppdbide.bl.serverdatacache;的ServerObject
我们需要修改该类中的isQualifiedSimpleObjectName方法。
为了保持前面“all”的value值也就是ColumnAll这个serverObject的名字合法性，我们需要进行判断，否则输出的会是一段两边带双引号的字符串，而不是我们所需要的字符串。
通过正则表达式来进行。

 /\*\*
 \* Checks if is qualified simple object name.
 \*
 \* @param objectName the object name
 \* @return true, if is qualified simple object name
 \*/
 public static boolean isQualifiedSimpleObjectName(String objectName) {
     if (null != objectName && !objectName.isEmpty() && objectName.matches("^([a-z\_][a-z|0-9|\_|$]\*)|([a-z\_][a-z|0-9|\_|,| |$]\*)$")) {
         return true;
     }
 
     return false;
 }