自己动手，丰衣足食：从零开始写个 IDEA 插件，要啥功能就做啥

Java代码的时候，经常会涉及到重复性的操作，这个时候就会想要是有这样一个插件就好了，如果是大家都会遇到的场景，IDE或许已经提供了，再不然也有可能有人编写了相关的插件。

要是这个操作是你们的编码环境特有的，那就只能自己写工具了。所以这里来学学如何编写IDEA插件，让自己的编程环境更加强大，更好的进行装x。

开发环境

开发IDEA插件有以下这些依赖：

IntelliJ IDEA Community Edition
IntelliJ IDEA Community Edition 源码
Plugin DevKit 插件
IntelliJ Platform SDK

安装IntelliJ IDEA Community Edition

你可能已经安装了Ultimate版本，但是你还是需要安装[IDEA][]的社区版本。因为商业版是闭源的，所以在调试时无法调试核心代码。

下载IntelliJ IDEA Community Edition源码

社区版的安装包里是不包含源码的，所以我们需要手动从github上clone一份：

git clone --depth 1 git://git.jetbrains.org/idea/community.git idea

关于从源码运行IDEA的方法参考 Check Out And Build Community Edition：

http://www.jetbrains.org/intellij/sdk/docs/basics/checkout_and_build_community.html

添加IDEA jdk

虽然不知道原因，但是根据Check Out And Build Community Edition：

http://www.jetbrains.org/intellij/sdk/docs/basics/checkout_and_build_community.html

我们需要建立一个 IDEA jdk来运行插件：

除非你在Mac上使用官方JDK，否则你需要手动添加 /lib/tools.jar到classpath中。关注微信公众号：匠心零度，在后台回复：idea，可以获取我整最新 IDEA 教程，都是干货。

配置IntelliJ Platform SDK

打开 File|ProjectStructure新建一个 IntelliJPlatformSDK：

Java SDK选择我们刚刚建立的 IDEA jdk：

然后我们可以把下载的IDEA社区版源码添加到源码路径中，这样在调试时，就可以调试IDEA自身的代码了：

第一个插件

我们来编写一个最简单的插件来学习编写一个插件的完整步骤。

新建工程

选择 IntellJPlatformPlugin，然后Project SDK指定刚刚新建的plugin sdk：

新建的插件项目：

插件根目录下有两个目录 src和 resources。src是插件代码目录， resource是插件资源目录，其中 META-INF/plugin.xml是插件的描述文件，就像Java web项目的 web.xml一样。

plugin.xml默认的内容如下：

<idea-plugin>    <id>com.your.company.unique.plugin.id</id>    <name>Plugin display name here</name>    <version>1.0</version>    <vendor email="support@yourcompany.com" url="http://www.yourcompany.com">YourCompany</vendor>    <description><!\[CDATA\[      Enter short description for your plugin here.<br>        <em>most HTML tags may be used</em>      \]\]></description>    <change-notes><!\[CDATA\[      Add change notes here.<br>        <em>most HTML tags may be used</em>      \]\]>  </change-notes>    <!\-\- please see http://www.jetbrains.org/intellij/sdk/docs/basics/getting\_started/build\_number_ranges.html for description -->  <idea-version since-build="145.0"/>    <!\-\- please see http://www.jetbrains.org/intellij/sdk/docs/basics/getting\_started/plugin\_compatibility.html       on how to target different products -->  <!\-\- uncomment to enable plugin in all products  <depends>com.intellij.modules.lang</depends>    -->  <extensions defaultExtensionNs="com.intellij">      <!\-\- Add your extensions here -->  </extensions>    <actions>      <!\-\- Add your actions here -->  </actions>  </idea-plugin>

新建一个Action

插件扩展IDEA最常见的方式就是在菜单栏或者工具栏中添加菜单项，用户通过点击菜单项来触发插件功能。IDEA提供了 AnAction类，这个类有一个虚方法 actionPerformed，这个方法会在每次菜单被点击时调用。

新建一个自定义的Action有两个步骤：

1、继承 AnAction类，在 actionPerformed方法中实现插件逻辑 2、注册action，有两种方式，通过代码注册和通过 plugin.xml注册

我们先写一个简单的Action类：

publicclass TextBoxes extends AnAction {      // 如果通过Java代码来注册，这个构造函数会被调用，传给父类的字符串会被作为菜单项的名称    // 如果你通过plugin.xml来注册，可以忽略这个构造函数    public TextBoxes() {          // 设置菜单项名称        super("Text _Boxes");          // 还可以设置菜单项名称，描述，图标        // super("Text _Boxes","Item description",IconLoader.getIcon("/Mypackage/icon.png"));    }      public void actionPerformed(AnActionEvent event) {          Project project = event.getData(PlatformDataKeys.PROJECT);          String txt= Messages.showInputDialog(project, "What is your name?", "Input your name", Messages.getQuestionIcon());          Messages.showMessageDialog(project, "Hello, " \+ txt + "!\n I am glad to see you.", "Information", Messages.getInformationIcon());      }  }

然后我们在 plugin.xml中注册这个Action：

<actions>    <group id="MyPlugin.SampleMenu" text="_Sample Menu" description="Sample menu">      <add-to-group group-id="MainMenu" anchor="last"  />         <action id="Myplugin.Textboxes"class="Mypackage.TextBoxes" text="Text _Boxes" description="A test menu item" />    </group>  </actions>

这里我们新建了一个菜单组，其中text字符串的下划线表示这个字母作为快捷键。这个菜单显示的效果如下：

除了手动新建Action，IDEA还提供了快速新建的方法，在代码目录上点击新建，可以看到Action：

可以在这个面板中填写你要新建的Action信息，IDEA会帮你新建类，还有在plugin.xml中帮你注册：

运行插件

运行插件特别简单，和运行普通Java代码一样，点击运行或者调试的按钮，就会启动一个新的IDEA实例，这个实例中插件是生效的。

点击Text Boxes就可以看到插件的效果了。

一步：官网下载IDEA

地址：https://www.jetbrains.com/idea/download/other.html

第二步：卸载旧的IDEA（没有则跳过）

打开电脑上的控制面板-->程序-->程序和功能，找到旧版IDEA，卸载时勾选提示的两个复选框，然后点击Uninstall。

第二步：安装IDEA

点击Next >

自定义安装路径，点击Next >

个人感觉只需要在64-bit launch前面打钩就行，下面的12345的功能如下：

创建桌面快捷方式图标，建议创建64位的图标
将IDEA的启动目录添加到环境变量中，从命令行也能启动idea，根据个人需要勾选。
勾选后，鼠标右键点击一个文件夹，会出现“Open Folder as Project”选项，个人感觉用处不大
关联这四个格式的文件，也就是以后打开java、groovy、kt、kts结尾的文件，默认使用idea打开。个人感觉用处也不大，如果是打开单个java文件，我更喜欢用notepad++。
下载java的jre环境，如果本机已经有java运行环境了就不用勾选。

点击Next >

点击install进行安装。

安装成功，点击Finish结束

第一次运行idea会让选择设置，我们选择第二个默认的即可。

近开始学习SpringBoot，和大家分享一下简单的SpringBoot项目搭建。

1.File->new->project；

2.选择“Spring Initializr”，点击next；（jdk1.8默认即可）

3、.完善项目信息，组名可不做修改，项目名可做修改；最终建的项目名为：demo，src->main->java下包名会是：com->springboot_learn->test；点击next；

4.Web下勾选Spring Web Start，（网上创建springboot项目多是勾选Web选项，而较高版本的Springboot没有此选项，勾选Spring Web Start即可，2.1.8版本是Spring Web）；SQL勾选：MySQL Driver，JDBC API 和 MyBatis Framework三项；点击next；

5.选择项目路径，点击finish；打开新的窗口；

6.刚创建好的项目目录结构

7.点击右侧的Maven，点击设置（扳手图标）进行项目Maven仓库的配置；

8.（1）选择本地Maven路径；（2）勾选配置文件后边的选项，然后修改为本地Maven的配置文件，它会根据配置文件直接找到本地仓库位置；

9.配置完后，如果没有自动导包，可以点击左上角重新导包按钮，或者呢个下载按钮，选择下载所有源文件和文档

10.在templates文件下新建index.html页面，作为启动的初始页面；

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>hello</title>
</head>
<body>
    你好！初学者，我是SpringBoot的简单启动页面！
</body>
</html>

11.在com.springboot_learn.test下新建controller文件夹，在controller文件夹下建一个简单的helloController类；（Controller类要添加@Controller注解，项目启动时，SpringBoot会自动扫描加载Controller）

package com.springboot.demo.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author 
 * @version 1.0
 * @date 2021/09/07 10:50 上午
 */

/**
 * Web层：就是Controller层，实现与web前端的交互。
 */
@RestController
@RequestMapping("/ceshi")
public class HelloWorldController {
    @RequestMapping("/index")
    public String sayHello(){
        System.out.println("测试开始");
        return "index";
    }

}

12.在resources文件夹下application中先配置DataSource基本信息，application文件有两种文件格式，一种是以.properties为后缀，一种是以.yml为后缀的，两种配置方式略有差别，。右键application文件选择Refact，选择Rename，将后缀改为yml；

spring:
  datasource:
    name: test #数据库名
    url: jdbc:mysql://localhost:3306/test?serverTimezone=GMT%2B8&useSSL=false #url
    username: root  #用户名
    password: 123456  #密码
    # 升级后的mysql驱动类，Driver位置由com.mysql.jdbc.Driver 变为com.mysql.cj.jdbc.Driver
    driver-class-name: com.mysql.cj.jdbc.Driver #数据库链接驱动

mybatis:
  mapper-locations: classpath:mapper/*.xml  #配置映射文件
  type-aliases-package: package com.springboot.demo.bean #配置实体类

13.运行项目启动类TestApplication.java

14.在浏览器中输入localhost:8080,回车显示初始的index界面；到这项目的初步搭建已经完成，下面可以下一些简单的业务逻辑，比如从数据库获取信息，登录之类的简单功能；

15.在进行下一步编写时，我们先来链接一下数据库；点击右侧的Database，点“加号”，新建数据库链接；

16.填写数据库相关信息，点击Test Connection；需要在本地先搭建Mysql数据库，database建立test，创建user表.

17.连接成功后，显示数据库信息，user表的基本信息也显示了，下面就照这个来了；

19.SpringBoot项目大概分为四层：

（1）DAO层：包括XxxMapper.java(数据库访问接口类)，XxxMapper.xml(数据库链接实现)；（这个命名，有人喜欢用Dao命名，有人喜欢用Mapper，看个人习惯了吧）

（2）Bean层：也叫model层，模型层，entity层，实体层，就是数据库表的映射实体类，存放POJO对象；

（3）Service层：也叫服务层，业务层，包括XxxService.java(业务接口类)，XxxServiceImpl.java（业务实现类）；（可以在service文件夹下新建impl文件放业务实现类，也可以把业务实现类单独放一个文件夹下，更清晰）

（4）Web层：就是Controller层，实现与web前端的交互。

依照上面四层，创建目录结构如下：

20.代码展示：

（1）在application配置文件中添加MyBatis配置：

spring:
  datasource:
    name: test #数据库名
    url: jdbc:mysql://localhost:3306/test?serverTimezone=GMT%2B8&useSSL=false #url
    username: root  #用户名
    password: 1qaz2wsx  #密码
    # 升级后的mysql驱动类，Driver位置由com.mysql.jdbc.Driver 变为com.mysql.cj.jdbc.Driver
    driver-class-name: com.mysql.cj.jdbc.Driver #数据库链接驱动

mybatis:
  mapper-locations: classpath:mapper/*.xml  #配置映射文件
  type-aliases-package: package com.springboot.demo.bean #配置实体类

（2）pom.xml文件配置信息

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.6.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>test</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>test</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.1.0</version>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.11</version>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

(3)Bean实体类，依据数据库表，生成set和get方法；

package com.springboot.demo.bean;

/**
 * @author 
 * @version 1.0
 * @date 2021/09/07 4:27 下午
 */
/**
 * Bean层：也叫model层，模型层，entity层，实体层，就是数据库表的映射实体类，存放POJO对象；
 * 依据数据库表，生成set和get方法；
 */
public class UserBean {
    private int id;
    private String name;
    private String password;

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }
}

（4）DAO层访问数据库接口文件：

package com.springboot.demo.mapper;

import com.springboot.demo.bean.UserBean;
/**
 * @author 
 * @version 1.0
 * @date 2021/09/07 4:41 下午
 */
/**
 * DAO层访问数据库接口文件
 */
public interface UserMapper {

    UserBean getInfo(String name,String password);

}

5）DAO层访问数据库实现文件（需在resource包下创建mapper文件夹，然后再创建一个UserMapper.xml.在application配置文件中mybatis:mapper-locations:对应的就是该文件地址），注意<mapper>标签的namespace属性要填写访问数据库接口类文件路径：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<mapper namespace="com.springboot.demo.mapper.UserMapper">

    <select id="getInfo" parameterType="String" resultType="com.springboot.demo.bean.UserBean">
        SELECT * FROM user WHERE name = #{name} AND password = #{password}
    </select>

</mapper>

（6）Service层业务接口类编写：

package com.springboot.demo.service;
import com.springboot.demo.bean.UserBean;
import org.springframework.stereotype.Repository;

/**
 * @author 
 * @version 1.0
 * @date 2021/09/07 4:29 下午
 */

/**
 * Service层：也叫服务层，业务层，包括XxxService.java(业务接口类)，XxxServiceImpl.java（业务实现类）；
 * （可以在service文件夹下新建impl文件放业务实现类，也可以把业务实现类单独放一个文件夹下，更清晰
 */

@Repository
public interface UserService {

    UserBean loginIn(String name,String password);

}

（7）Service层业务实现类编写，注意要注解@Service，注入DAO：

package com.springboot.demo.impl;
import com.springboot.demo.bean.UserBean;
import com.springboot.demo.mapper.UserMapper;
import com.springboot.demo.service.UserService;

/**
 * @author 
 * @version 1.0
 * @date 2021/09/07 4:48 下午
 */
/**
 * Service层业务实现类编写，注意要注解@Service，注入DAO：
 */
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class UserServiceImpl implements UserService {

    //将DAO注入Service层
    @Autowired
    private UserMapper userMapper;

    @Override
    public UserBean loginIn(String name, String password) {
        return userMapper.getInfo(name,password);
    }
}

8）项目启动类要添加注解@MapperScan项目启动时扫描mapper接口，否则会报错找不到mapper文件：

package com.springboot.demo;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@MapperScan("com.springboot.demo.mapper")

public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class);
    }

}

（9）编写测试类，看是否能成功访问数据库，获取数据库信息：

package com.springboot.demo;


import com.springboot.demo.bean.UserBean;
import com.springboot.demo.service.UserService;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

@RunWith(SpringRunner.class)
@SpringBootTest
public class TestApplicationTests {

    @Autowired
    UserService userService;

    @Test
    public void contextLoads() {
        UserBean userBean = userService.loginIn("springboot", "123456");
        System.out.println("该用户ID为：");
        System.out.println(userBean.getId());
    }
}

（10） controller层，注意添加@controller注解，注入Service服务：

package com.springboot.demo.controller;

/**
 * @author 
 * @version 1.0
 * @date 2021/09/07 4:58 下午
 */

import com.springboot.demo.bean.UserBean;
import com.springboot.demo.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

@Controller
public class LoginController {

    //将Service注入Web层
    @Autowired
    UserService userService;

    @RequestMapping("/login")
    public String show(){
        return "login";
    }

    @RequestMapping(value = "/loginIn",method = RequestMethod.POST)
    public String login(String name,String password){
        UserBean userBean = userService.loginIn(name,password);
        if(userBean!=null){
            return "success";
        }else {
            return "error";
        }
    }
}

（11）html文件：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>login</title>
</head>
<body>
    <form role="form" action = "/loginIn" method="post">
        账号：<input type="text" id="name" name = "name"> <br>
        密码：<input type="password" id = "password" name = "password"> <br>
        <input type="submit" id = "login" value = "login">
    </form>
 
</body>
</html>

success.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>success</title>
</head>
<body>
    <h1>登录成功！</h1>
</body>
</html>

error.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>error</title>
</head>
<body>
    <h1>登录失败！</h1>
</body>
</html>

21.先运行测试类，看是否成功获取数据库信息：

22.运行TestApplication.java文件，启动项目，无任何WARN警告信息，进入浏览器输入localhost:8080/login

项目到这里就算完美结束了，对自己说一声，加油，努力学习。

分享是人们与社会产生联系的一种方式，本质上是一种互利行为，在互利中，选择、巩固和发展彼此的社会关系。完全没有分享，社会将不能成立。分享是构成社会的要素之一。

在线咨询

上一篇：前端开发规范：命名规范、html规范、css规范、js规范
下一篇：Nodejs常用模板引擎

您的项目需求

*请认真填写需求信息，我们会在24小时内与您取得联系。

整合营销服务商