# nacos-datasource-extend-plugins

**Repository Path**: shentongdata/nacos-datasource-extend-plugins

## Basic Information

- **Project Name**: nacos-datasource-extend-plugins
- **Description**: nacos神通数据源插件
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-07-07
- **Last Updated**: 2024-02-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Nacos2.2版本神通数据库适配插件

## 一、插件概述

### 1.1、简介

从2022年12月14日发布的Nacos2.2正式版本开始，Nacos提供了数据源扩展插件，以便让需要进行其他数据库适配的用户自己编写插件来保存数据。
当前项目插件目前已简单适配神通数据库，并抽象了一套常见的兼容项的方言类，开发者可以基于该设计，实现自定义分页逻辑即可。

当前项目基于Nacos2.2版本的扩展插件口进行开发。
如使用需使用神通数据库的nacos数据源插件直接使用根目录下的nacos-oscar-datasource-plugin-ext-1.0.0-SNAPSHOT.jar包即可，将此jar包放于nacos根目录下的plugins文件夹中,nacos会自动使用spi机制加载该jar包。

### 2.2、插件工程结构说明

nacos-datasource-plugin-ext工程主目录 

----nacos-datasource-plugin-ext-base工程设计为数据库插件操作的适配抽象。

----nacos-all-datasource-plugin-ext工程计划可打包所有适配的数据库插件

----nacos-oscar-datasource-plugin-ext工程可打包适配oscar的数据库插件

## 二、下载和使用

IDEA导入时导入nacos-datasource-plugin-ext这个目录作为根目录即可。

### 2.1、插件引入

**方式一：源码方式**

使用该maven库作为依赖引入到Nacos主分支源码中，使用Maven提前将当前工程Install到Maven仓库，然后在Pom.xml中引入如下依赖：

```xml
<dependency>
    <groupId>com.alibaba.nacos</groupId>
    <artifactId>nacos-oscar-datasource-plugin-ext</artifactId>
    <version>1.0.0-SNAPSHOT</version>
</dependency>
```

或引入all模块。

**方式二：打包形式引入**

在Nacos2.2的发布包环境下，下载当前插件项目源码，打包为jar包（项目路径下nacos-datasource-extend-plugins/nacos-oscar-datasource-plugin-ext-1.0.0-SNAPSHOT.jar已打包好可直接使用），
将该文件放到nacos主目录下的plugins文件夹中，默认会使用Nacos的loader.path机制指定该插件的路径，打包插件可选择nacos-oscar-datasource-plugin-ext打包即可。oscar模块的打包默认会包含神通数据库的jdbc驱动类和base依赖。

### 2.2、修改数据库配置文件

在application.properties文件中声明oscar的配置信息：

```java
spring.datasource.platform=oscar
db.url.0=jdbc:oscar://127.0.0.1:5432/OSRDB?logintimeout=30000&ApplicationName=nacos_java
db.user=NACOS
db.password=xxxxxx
db.pool.config.driverClassName=com.oscar.Driver
```

### 2.3、导入神通数据的数据库脚本文件
创建神通数据库NACOS用户
```SQL
CREATE USER NACOS PASSWORD 'your password'
```
登录NACOS用户执行nacos-oscar.sql脚本文件，脚本文件在nacos-oscar-datasource-plugin-ext/src/main/resources/schema文件夹下面.

上面操作完成后，启动Nacos即可。