【开发经验】为linkis-public-enhancements 新建子模块

[jacktao007]

作者：jacktao007
微信：YourHeroBaby

背景

在开发基础数据管理功能时，进入linkis目录发现这么多模块，我应该把我的代码加到哪里呢？我们可以在原有的代码中新增代码，或者新建子模块来编写代码，本文介绍了如何新建子模块来添加自己的代码。

1.新建子模块

1.创建模块

2.使用maven创建

3.设置子模块名称

4.设置maven

5.修改pom

（1）parent
<parent> <groupId>org.apache.linkis</groupId> <artifactId>linkis</artifactId> <version>1.2.0</version> <relativePath>../../pom.xml</relativePath> </parent>
（2）添加packaging
<packaging>jar</packaging>
（3）去除properties 标签
（4）修改依赖

<dependencies>
    <dependency>
      <groupId>org.apache.linkis</groupId>
      <artifactId>linkis-module</artifactId>
      <version>${project.version}</version>
      <exclusions>
        <exclusion>
          <groupId>org.ow2.asm</groupId>
          <artifactId>asm</artifactId>
        </exclusion>
      </exclusions>
    </dependency>
    <dependency>
      <groupId>org.apache.linkis</groupId>
      <artifactId>linkis-mybatis</artifactId>
      <version>${project.version}</version>
    </dependency>
  </dependencies>

（5）更换build标签

    <finalName>${project.artifactId}-${project.version}</finalName>
    <resources>
      <resource>
        <directory>src/main/resources</directory>
      </resource>
      <resource>
        <directory>src/main/java</directory>
        <includes>
          <include>**/*.xml</include>
        </includes>
      </resource>
    </resources>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-deploy-plugin</artifactId>
      </plugin>
      <plugin>
        <groupId>net.alchim31.maven</groupId>
        <artifactId>scala-maven-plugin</artifactId>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-jar-plugin</artifactId>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-assembly-plugin</artifactId>
        <version>3.2.0</version>
        <inherited>false</inherited>
        <configuration>
          <skipAssembly>false</skipAssembly>
          <finalName>out</finalName>
          <appendAssemblyId>false</appendAssemblyId>
          <attach>false</attach>
          <descriptors>
            <descriptor>src/main/assembly/distribution.xml</descriptor>
          </descriptors>
        </configuration>
        <executions>
          <execution>
            <id>make-assembly</id>
            <goals>
              <goal>single</goal>
            </goals>
            <phase>package</phase>
            <configuration>
              <descriptors>
                <descriptor>src/main/assembly/distribution.xml</descriptor>
              </descriptors>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>

6.删除test目录

7.设置java为源码目录

8.新建demo包

9.删除App类

10.添加LinkisDemoApplication 类

 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.linkis.demo;

import org.apache.linkis.LinkisBaseServerApp;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

public class LinkisDemoApplication {

    private static final Log logger = LogFactory.getLog(LinkisBasedataManagerApplication.class);

    public static void main(String[] args) throws ReflectiveOperationException {
        logger.info("Start to running LinkisDataSourceManagerApplication");
        LinkisBaseServerApp.main(args);
    }
}

11.添加assembly/distribution.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
  ~ Licensed to the Apache Software Foundation (ASF) under one or more
  ~ contributor license agreements.  See the NOTICE file distributed with
  ~ this work for additional information regarding copyright ownership.
  ~ The ASF licenses this file to You under the Apache License, Version 2.0
  ~ (the "License"); you may not use this file except in compliance with
  ~ the License.  You may obtain a copy of the License at
  ~ 
  ~   http://www.apache.org/licenses/LICENSE-2.0
  ~ 
  ~ Unless required by applicable law or agreed to in writing, software
  ~ distributed under the License is distributed on an "AS IS" BASIS,
  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  ~ See the License for the specific language governing permissions and
  ~ limitations under the License.
  -->
  
<assembly
        xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/2.3"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/2.3 http://maven.apache.org/xsd/assembly-1.1.2.xsd">
    <id>linkis-demo</id>
    <formats>
        <format>dir</format>
    </formats>
    <includeBaseDirectory>false</includeBaseDirectory>
    <baseDirectory>linkis-demo</baseDirectory>

    <dependencySets>
        <dependencySet>
            <!-- Enable access to all projects in the current multimodule build! <useAllReactorProjects>true</useAllReactorProjects> -->
            <!-- Now, select which projects to include in this module-set. -->
            <outputDirectory>lib</outputDirectory>
            <useProjectArtifact>true</useProjectArtifact>
            <useTransitiveDependencies>true</useTransitiveDependencies>
            <unpack>false</unpack>
            <useStrictFiltering>false</useStrictFiltering>
            <useTransitiveFiltering>true</useTransitiveFiltering>
            <excludes> <!-- 不包括 -->
                <exclude>antlr:antlr:jar</exclude>
                <exclude>aopalliance:aopalliance:jar</exclude>
                <exclude>com.fasterxml.jackson.core:jackson-annotations:jar</exclude>
                <exclude>com.fasterxml.jackson.core:jackson-core:jar</exclude>
                <exclude>com.fasterxml.jackson.core:jackson-databind:jar</exclude>
                <exclude>com.fasterxml.jackson.module:jackson-module-paranamer:jar</exclude>
                <exclude>com.fasterxml.jackson.module:jackson-module-scala_2.11:jar</exclude>
                <exclude>com.google.code.gson:gson:jar</exclude>
                <exclude>com.google.guava:guava:jar</exclude>
                <exclude>com.google.protobuf:protobuf-java:jar</exclude>
                <exclude>com.netflix.archaius:archaius-core:jar</exclude>
                <exclude>com.netflix.hystrix:hystrix-core:jar</exclude>
                <exclude>com.netflix.netflix-commons:netflix-commons-util:jar</exclude>
                <exclude>com.netflix.netflix-commons:netflix-statistics:jar</exclude>
                <exclude>com.netflix.ribbon:ribbon:jar</exclude>
                <exclude>com.netflix.ribbon:ribbon-core:jar</exclude>
                <exclude>com.netflix.ribbon:ribbon-httpclient:jar</exclude>
                <exclude>com.netflix.ribbon:ribbon-loadbalancer:jar</exclude>
                <exclude>com.netflix.ribbon:ribbon-transport:jar</exclude>
                <exclude>com.netflix.servo:servo-core:jar</exclude>
                <exclude>com.ning:async-http-client:jar</exclude>
                <exclude>com.sun.jersey.contribs:jersey-apache-client4:jar</exclude>
                <exclude>com.sun.jersey:jersey-client:jar</exclude>
                <exclude>com.sun.jersey:jersey-core:jar</exclude>
                <exclude>com.sun.jersey:jersey-server:jar</exclude>
                <exclude>com.sun.xml.bind:jaxb-impl:jar</exclude>
                <exclude>org.apache.linkis:linkis-common:jar</exclude>
                <exclude>commons-beanutils:commons-beanutils:jar</exclude>
                <exclude>commons-beanutils:commons-beanutils-core:jar</exclude>
                <exclude>commons-cli:commons-cli:jar</exclude>
                <exclude>commons-collections:commons-collections:jar</exclude>
                <exclude>commons-configuration:commons-configuration:jar</exclude>
                <exclude>commons-daemon:commons-daemon:jar</exclude>
                <exclude>commons-dbcp:commons-dbcp:jar</exclude>
                <exclude>commons-digester:commons-digester:jar</exclude>
                <exclude>commons-io:commons-io:jar</exclude>
                <exclude>commons-lang:commons-lang:jar</exclude>
                <exclude>commons-net:commons-net:jar</exclude>
                <exclude>commons-pool:commons-pool:jar</exclude>
                <exclude>io.netty:netty:jar</exclude>
                <exclude>io.netty:netty-all:jar</exclude>
                <exclude>io.netty:netty-buffer:jar</exclude>
                <exclude>io.netty:netty-codec:jar</exclude>
                <exclude>io.netty:netty-codec-http:jar</exclude>
                <exclude>io.netty:netty-common:jar</exclude>
                <exclude>io.netty:netty-handler:jar</exclude>
                <exclude>io.netty:netty-transport:jar</exclude>
                <exclude>io.netty:netty-transport-native-epoll:jar</exclude>
                <exclude>io.reactivex:rxjava:jar</exclude>
                <exclude>io.reactivex:rxnetty:jar</exclude>
                <exclude>io.reactivex:rxnetty-contexts:jar</exclude>
                <exclude>io.reactivex:rxnetty-servo:jar</exclude>
                <exclude>javax.activation:activation:jar</exclude>
                <exclude>javax.annotation:javax.annotation-api:jar</exclude>
                <exclude>javax.inject:javax.inject:jar</exclude>
                <exclude>javax.servlet:javax.servlet-api:jar</exclude>
                <exclude>javax.servlet.jsp:jsp-api:jar</exclude>
                <exclude>javax.xml.bind:jaxb-api:jar</exclude>
                <exclude>javax.xml.stream:stax-api:jar</exclude>
                <exclude>net.databinder.dispatch:dispatch-core_2.11:jar</exclude>
                <exclude>net.databinder.dispatch:dispatch-json4s-jackson_2.11:jar</exclude>
                <exclude>org.antlr:antlr-runtime:jar</exclude>
                <exclude>org.antlr:stringtemplate:jar</exclude>
                <exclude>org.apache.commons:commons-compress:jar</exclude>
                <exclude>org.apache.commons:commons-math3:jar</exclude>
                <exclude>org.apache.curator:curator-framework:jar</exclude>
                <exclude>org.apache.curator:curator-recipes:jar</exclude>
                <exclude>org.apache.directory.api:api-asn1-api:jar</exclude>
                <exclude>org.apache.directory.api:api-util:jar</exclude>
                <exclude>org.apache.directory.server:apacheds-i18n:jar</exclude>
                <exclude>org.apache.directory.server:apacheds-kerberos-codec:jar</exclude>
                <exclude>org.apache.hadoop:hadoop-annotations:jar</exclude>
                <exclude>org.apache.hadoop:hadoop-auth:jar</exclude>
                <exclude>org.apache.hadoop:hadoop-common:jar</exclude>
                <exclude>org.apache.hadoop:hadoop-hdfs:jar</exclude>
                <exclude>org.apache.htrace:htrace-core:jar</exclude>
                <exclude>org.apache.logging.log4j:log4j-api:jar</exclude>
                <exclude>org.apache.zookeeper:zookeeper:jar</exclude>
                <exclude>org.aspectj:aspectjweaver:jar</exclude>
                <exclude>org.bouncycastle:bcpkix-jdk15on:jar</exclude>
                <exclude>org.bouncycastle:bcprov-jdk15on:jar</exclude>
                <exclude>org.codehaus.jettison:jettison:jar</exclude>
                <exclude>org.eclipse.jetty:jetty-continuation:jar</exclude>
                <exclude>org.eclipse.jetty:jetty-http:jar</exclude>
                <exclude>org.eclipse.jetty:jetty-io:jar</exclude>
                <exclude>org.eclipse.jetty:jetty-jndi:jar</exclude>
                <exclude>org.eclipse.jetty:jetty-plus:jar</exclude>
                <exclude>org.eclipse.jetty:jetty-security:jar</exclude>
                <exclude>org.eclipse.jetty:jetty-server:jar</exclude>
                <exclude>org.eclipse.jetty:jetty-servlet:jar</exclude>
                <exclude>org.eclipse.jetty:jetty-util:jar</exclude>
                <exclude>org.eclipse.jetty:jetty-webapp:jar</exclude>
                <exclude>org.eclipse.jetty:jetty-xml:jar</exclude>
                <exclude>org.fusesource.leveldbjni:leveldbjni-all:jar</exclude>
                <exclude>org.hdrhistogram:HdrHistogram:jar</exclude>
                <exclude>org.json4s:json4s-ast_2.11:jar</exclude>
                <exclude>org.json4s:json4s-core_2.11:jar</exclude>
                <exclude>org.json4s:json4s-jackson_2.11:jar</exclude>
                <exclude>org.jsoup:jsoup:jar</exclude>
                <exclude>org.mortbay.jetty:jetty:jar</exclude>
                <exclude>org.mortbay.jetty:jetty-util:jar</exclude>
                <exclude>org.scala-lang.modules:scala-parser-combinators_2.11:jar</exclude>
                <exclude>org.scala-lang.modules:scala-xml_2.11:jar</exclude>
                <exclude>org.scala-lang:scala-compiler:jar</exclude>
                <exclude>org.scala-lang:scala-library:jar</exclude>
                <exclude>org.scala-lang:scala-reflect:jar</exclude>
                <exclude>org.scala-lang:scalap:jar</exclude>
                <exclude>org.slf4j:jul-to-slf4j:jar</exclude>
                <exclude>org.slf4j:slf4j-api:jar</exclude>
                <exclude>org.springframework.boot:spring-boot:jar</exclude>
                <exclude>org.springframework.boot:spring-boot-autoconfigure:jar</exclude>
                <exclude>org.springframework.boot:spring-boot-starter:jar</exclude>
                <exclude>org.springframework.boot:spring-boot-starter-aop:jar</exclude>
                <exclude>org.springframework.cloud:spring-cloud-commons:jar</exclude>
                <exclude>org.springframework.cloud:spring-cloud-context:jar</exclude>
                <exclude>org.springframework.cloud:spring-cloud-netflix-archaius:jar</exclude>
                <exclude>org.springframework.cloud:spring-cloud-netflix-ribbon:jar</exclude>
                <exclude>org.springframework.cloud:spring-cloud-starter:jar</exclude>
                <exclude>org.springframework.cloud:spring-cloud-starter-netflix-archaius:jar</exclude>
                <exclude>org.springframework.cloud:spring-cloud-starter-netflix-ribbon:jar</exclude>
                <exclude>org.springframework.security:spring-security-crypto:jar</exclude>
                <exclude>org.springframework.security:spring-security-rsa:jar</exclude>
                <exclude>org.springframework:spring-aop:jar</exclude>
                <exclude>org.springframework:spring-beans:jar</exclude>
                <exclude>org.springframework:spring-context:jar</exclude>
                <exclude>org.springframework:spring-core:jar</exclude>
                <exclude>org.springframework:spring-expression:jar</exclude>
                <!--<exclude>org.springframework:spring-jcl:jar</exclude>-->
                <exclude>org.springframework:spring-web:jar</exclude>
                <exclude>org.tukaani:xz:jar</exclude>
                <exclude>org.yaml:snakeyaml:jar</exclude>
                <exclude>xerces:xercesImpl:jar</exclude>
                <exclude>xml-apis:xml-apis:jar</exclude>
                <exclude>xmlenc:xmlenc:jar</exclude>
            </excludes>
        </dependencySet>
    </dependencySets>
    <!-- 文件集合 -->
    <fileSets>
        <fileSet>
            <directory>${basedir}/src/main/resources</directory>
            <includes>
                <include>*</include>
            </includes>
            <fileMode>0777</fileMode>
            <outputDirectory>conf</outputDirectory>
            <lineEnding>unix</lineEnding>
        </fileSet>
    </fileSets>

</assembly>

12.新建目录

dao domain restful service

13.添加默认服务列表 demo

路径 linkis-commons/linkis-rpc/src/main/scala/org/apache/linkis/rpc/conf/RPCConfiguration.scala
变量名 PUBLIC_SERVICE_LIST

 val PUBLIC_SERVICE_LIST: Array[String] = CommonVars(
    "wds.linkis.gateway.conf.publicservice.list",
    "cs,contextservice,data-source-manager,metadataquery,metadatamanager,query,jobhistory,application,configuration,filesystem,udf,variable,microservice,errorcode,bml,datasource,basedata-manager,demo"
  ).getValue.split(",")

14.添加数据库配置到 配置文件中

路径linkis-dist/package/conf/linkis-ps-publicservice.properties

##restful
wds.linkis.server.restful.scan.packages=org.apache.linkis.cs.server.restful,org.apache.linkis.datasourcemanager.core.restful,org.apache.linkis.metadata.query.server.restful,org.apache.linkis.jobhistory.restful,org.apache.linkis.variable.restful,org.apache.linkis.configuration.restful,org.apache.linkis.udf.api,org.apache.linkis.filesystem.restful,org.apache.linkis.filesystem.restful,org.apache.linkis.instance.label.restful,org.apache.linkis.metadata.restful.api,org.apache.linkis.cs.server.restful,org.apache.linkis.bml.restful,org.apache.linkis.errorcode.server.restful,org.apache.linkis.basedatamanager.server.restful,org.apache.linkis.demo.restful

##mybatis
wds.linkis.server.mybatis.mapperLocations=classpath*:org/apache/linkis/cs/persistence/dao/impl/*.xml,classpath:org/apache/linkis/datasourcemanager/core/dao/mapper/*.xml,classpath:org/apache/linkis/jobhistory/dao/impl/*.xml,classpath:org/apache/linkis/variable/dao/impl/*.xml,classpath:org/apache/linkis/configuration/dao/impl/*.xml,classpath:org/apache/linkis/udf/dao/impl/*.xml,classpath:org/apache/linkis/instance/label/dao/impl/*.xml,classpath:org/apache/linkis/metadata/hive/dao/impl/*.xml,org/apache/linkis/metadata/dao/impl/*.xml,classpath:org/apache/linkis/bml/dao/impl/*.xml,classpath*:org/apache/linkis/basedatamanager/server/dao/mapper/*.xml,classpath*:org/apache/linkis/demo/dao/mapper/*.xml

wds.linkis.server.mybatis.typeAliasesPackage=org.apache.linkis.cs.persistence.entity,org.apache.linkis.datasourcemanager.common.domain,org.apache.linkis.datasourcemanager.core.vo,org.apache.linkis.configuration.entity,org.apache.linkis.jobhistory.entity,org.apache.linkis.udf.entity,org.apache.linkis.variable.entity,org.apache.linkis.instance.label.entity,org.apache.linkis.manager.entity,org.apache.linkis.metadata.domain,org.apache.linkis.bml.entity,org.apache.linkis.bml.Entity,org.apache.linkis.basedatamanager.server.domain,org.apache.linkis.demo.dpmain

wds.linkis.server.mybatis.BasePackage=org.apache.linkis.cs.persistence.dao,org.apache.linkis.datasourcemanager.core.dao,org.apache.linkis.jobhistory.dao,org.apache.linkis.variable.dao,org.apache.linkis.configuration.dao,org.apache.linkis.udf.dao,org.apache.linkis.instance.label.dao,org.apache.linkis.metadata.hive.dao,org.apache.linkis.metadata.dao,org.apache.linkis.bml.dao,org.apache.linkis.errorcode.server.dao,org.apache.linkis.publicservice.common.lock.dao,org.apache.linkis.basedatamanager.server.dao,org.apache.linkis.demo.dao

2.格式化编码

1.添加 spotless-maven-plugin 插件

   <plugin>
          <groupId>com.diffplug.spotless</groupId>
          <artifactId>spotless-maven-plugin</artifactId>
          <version>${spotless-maven-plugin.version}</version>
          <configuration>
            <pom>
              <sortPom></sortPom>
            </pom>
            <java>
              <googleJavaFormat>
                <version>1.7</version>
                <style>GOOGLE</style>
              </googleJavaFormat>

              <!-- \# refers to the static imports -->
              <importOrder>
                <order>org.apache.linkis,org.apache,org.springframework,javax,java,scala,,\#</order>
              </importOrder>

              <excludes>
                <exclude>**/restful/**/*RestfulApi.java</exclude>
                <exclude>**/restful/**/*Restful.java</exclude>
              </excludes>

              <removeUnusedImports></removeUnusedImports>
            </java>
            <scala>
              <scalafmt>
                <file>${maven.multiModuleProjectDirectory}/.scalafmt.conf</file>
              </scalafmt>
              <licenseHeader>
                <file>${maven.multiModuleProjectDirectory}/tool/license-header</file>
                <delimiter>package</delimiter>
              </licenseHeader>
            </scala>
          </configuration>
          <executions>
            <execution>
              <id>spotless-check</id>
              <goals>
                <goal>check</goal>
              </goals>
              <phase>validate</phase>
            </execution>
          </executions>
        </plugin>

2.格式化代码

mvn spotless:apply

[Ritakang0451]

内容超棒！ Jack 你觉得 补充一些前期背景的描述会方便大家更好的了解事件经过,借鉴经验吗？

[jacktao007]

好的，稍后补充一些内容