lss233 3 min read
{0x12} Phoenix模块开发教程:创建你的项目主类

现在,我们终于可以开始写代码啦!

这篇文章属于Phoenix Framework 入门教程的一部分。

创建主类

在IntelliJ IDEA的Project窗口中,右键java文件夹(它应该是 src > main > java)

单击 New > Java Class

Create New Class窗口中,
Name处填写你的类名。
还记得上一节中我们填写的Group IdArtifact Id吗?
你的类名最好这样填: <Group Id>.<Artifact Id>.<Mod Id>Module
Create-New-Class_051

当你创建好你的主类后,你的主类必须有 PhoenixModule 这个注解(Annotation)。这个注解能够让 Phoenix 找到你的主类。
另外,你的主类还需要继承Module这个类,这样Phoenix才能正确调用它。
下面是一个例子:

package com.lss233.tutorial;


import com.lss233.phoenix.module.Module;
import com.lss233.phoenix.module.PhoenixModule;

@PhoenixModule(modid = "mymod", name = "My First Phoenix Module", version = "1.0.0")
public class TutorialModule extends Module{
    @Override
    public void onInitial() {

    }

    @Override
    public void onEnable() {

    }

    @Override
    public void onDisable() {

    }
}

下面,我们来看看刚刚写了什么。

PhoenixModule注解

@PhoenixModule(...) 在Java中表示一个注解(Annotation)。

拓展阅读: 框架开发之Java注解的妙用

咱的这个注解向Phoenix简单介绍了一下你的模块,它的所有参数如下:

名字 描述 例子
modid 必填.你的Mod Id,这个Id必须独一无二,否则会出现冲突的情况. mymod
name 必填. 你的模块名字,主要是给使用者看的. My First Module
version 必填. 你的模块版本. 1.0.0-SNAPSHOT

Module类

注意到了吗,我们的TutorialModule类继承了Module类
这个类是一个抽象类,它会要求继承他的子类实现下面几个方法。

onInitial()

在模块被初始化时,该方法会被调用。这个时候你可以初始化一些相关配置、数据库等,以便将来调用。

onEnable()

在模块被启用时,该方法会被调用。这个时候,所有能使用的模块都已经被初始化完毕了。你可以在此时与其他模块相互连接、监听事件、注册命令等。

onDisable()

在模块被禁用时,该方法会被调用。你可以在此时进行收尾工作,比如保存配置文件、断开数据库连接、说再见等。

总结

到了目前为止,你已经成功创建了一个能够被Phoenix框架加载的模块。
可以说,你已经成功写出了一个Hello World了。