富文本编辑器starter化

这里是对spring-boot-starter的一些介绍

以下介绍性话语可以跳过、

在项目中把一些非业务代码的部分抽取处理作为一个jar包使用，可以极大提高自身后续项目开发，举个例子，以百度富文本编辑器而言。如果在没有将其组件化的时候，每次在项目中使用的时候，需要将官方包中的各个源码拷贝，再修改其包引用路径，加之其余的一些配置内容，及其繁琐。在每次使用springboot的时候我们会发现，对于springboot而言，当我们需要完成一个AOP的功能引入其Aop starter依赖即可调用其相关功能，于是将百度富文本编辑器复杂的后端配置信息starter化的想法就有了。

图文教程

这里以项目中的情景来讲。如下图所示富文本编辑器内嵌到项目中，整个感觉对项目结构影响很不美观

原本项目结构.png

将其拆分的第一步，构建额外的maven项目，该项目作为一个starter，需要注意的是这个starter项目之中是不写代码的。该starter主要功能是作为一个版本控制的功能。

对于starter，spring官方有一定的命名规则要求。

starter项目中不写代码，但是需要在资源文件路径下创建 \META-INF\spring.factories文件，其作用是让引用jar包后spring可以依据spi机制，将对于的class资源加载至虚拟机

命名规则一般是以sping-boot-xxx-starter的方式命名

以上规则不遵守也可以完成需要的效果（除了创建 \META-INF\spring.factories必须做），但是会显得自己的starter没那么专业。

创建maven项目路径：
其一：选中file->Project Structure->model

创建maven项目.png

点击next输入对应的maven项目名
创建结构如下的两个项目：
项目1：starter启动类

启动类结构.png

需要导入引用的依赖包：

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
            <version>2.2.1.RELEASE</version>
        </dependency>
        <dependency>
           ...此处为core项目的项目依赖
        </dependency>
    </dependencies>

spring.factories配置文件内容：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=...core项目的初始加载类，一般为其配置类

项目2：core项目

此项目为具体的业务功能实现类，将ueditor中的代码挪到core下，创建项目结构如图

整合后的图片.png

此处的整合过程中对原有代码进行了一定的优化。为了避免耦合性，直接在core中将原有的controller改为一个拦截器，本人使用的富文本编辑器的配置文件是通过“/config”这个接口来请求的，改成拦截器之后，让其拦截“/config”的请求可以做到一样的效果。需要注意的是这个过程中因为富文本编辑器是默认不支持跨域的，所以可以加上跨域设置支持其跨域。
将controller改造为拦截器后的代码如下：

@Component
public class UEditorHandleInterceptor implements HandlerInterceptor{

    private ThreadLocal<String> exec =new ThreadLocal<>();

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        response.setContentType("application/json");
        response.setHeader("Access-Control-Allow-Origin", "*");
        String rootPath = request.getSession().getServletContext().getRealPath("/");
        exec.set(new ActionEnter(request, rootPath).exec());
        OutputStream  writer= response.getOutputStream();
        writer.write(exec.get().getBytes());
        writer.flush();
        writer.close();
        return false;
    }
}

需要配置类上配置该拦截器，同时将配置类作为初始加载类加载

@Configuration
public class UEditorConfiguration  implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new UEditorHandleInterceptor())
                .addPathPatterns("/config");
    }
}

以下只是一个简单的配置实现方式，对于配置项的设置处理在这里并未进行完善，但基本的将一个功能做成一个starter的组件的思路就是如此。

要注意的是，一个模块化的jar包导入后，系统在运行过程中会将core项目中配置文件中的文件加载到项目中，因而，在core中用@Bean定义的bean对象是可以在引用的项目中通过spring注入的方式直接调用，因而对于一些bean的默认配置可以直接在configure中进行配置。

补充

可以在starter的core项目中，使用配置实体类来将core中的配置事项在主项目的yml中配置（推荐）。具体的操作如下：

1.在core项目中引入依赖

    <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <version>2.2.1.RELEASE</version>
        </dependency>

2.编写配置类对象

@ConfigurationProperties("com.ueditor.resource")
public class UEditorProperties {
    private String path;

    public String getPath() {
        return path;
    }

    public void setPath(String path) {
        this.path = path;
    }
}

3.将配置项数据引入到core项目的配置类中，不配置的情况下是会报红线的编译异常的

@Configuration
@EnableConfigurationProperties(value = {UEditorProperties.class})
public class UEditorConfiguration  implements WebMvcConfigurer {
    @Bean
    @ConditionalOnProperty(value = {"com.ueditor.resource"},matchIfMissing = true)
    public Object object(UEditorProperties properties){
        return new Object();
    }

  ....你的其它代码
}

使用@ConditionalOnProperty，指定适用情况，详情自行找官方文档或者百度吧

此两个项目编写完后可以打包为jar包了，点击

打包.png

在自己的maven仓库下可以看到对应的jar包，这个jar包可以供自己项目组的其余成员调用其服务