Ketergantungan Injeksi

Sponge menggunakan dependency injection untuk memberikan contoh dari API untuk plugin. Dependency injection memungkinkan plugin untuk menunjuk beberapa jenis API yang akan disuntikkan setelah konstruksi.

Daftar sementara Disuntikkan Jenis

ConfigDir (annotation on Path or File)
Digunakan untuk menyuntik direktori konfigurasi plugin: ./mods/ ATAU ./mods/<Plugin#id>/ tergantung pada ConfigDir#sharedRoot()
ConfigurationLoader<CommentedConfigurationNode>
Harus dijelaskan dengan @DefaultConfig. Digunakan untuk menyuntik sebelum-dihasilkan ``ConfigurationLoader``untuk ``File``dari penjelasan yang sama.
DefaultConfig (annotation on Path, ConfigurationLoader or File)
Digunakan untuk menyuntikkan plugin tertentu file konfigurasi: <Plugin#id>.conf
EventManager
Mengelola pendaftaran event handler dan pengiriman dari peristiwa.
Berkas
Harus dijelaskan dengan baik @DefaultConfig atau``@ConfigDir``. Tergantung pada penjelasan yang diberikan ini akan berisi file referensi untuk plugin default config file atau direktori yang digunakan untuk menyimpan file-file konfigurasi. Namun, Path (lihat di bawah) harus diutamakan.
Game
Objek ``Game``adalah inti dari asesor SpongeAPI.
GameRegistry
Menyediakan cara yang mudah untuk mengambil jenis dari sebuah Permainan.
GuiceObjectMapperFactory
Alat yang disediakan oleh Membentuk untuk memungkinkan lebih mudah pemetaan benda-benda untuk konfigurasi node.Lihat :doc: konfigurasi/serialisasi untuk penggunaan.
Injektor
``com.google.inject.Injector``tersedia dari Perintah, itu adalah injektor yang digunakan untuk menyuntikkan plugin anda ketergantungan. Anda dapat menggunakannya untuk membuat anak injector dengan modul anda sendiri dalam rangka untuk menyuntikkan sendiri kelas dengan baik Spons yang disediakan dependensi yang tercantum di halaman ini, atau mengkonfigurasi kelas sendiri
Logger
Digunakan untuk mengidentifikasi plugin yang dicatat pesan yang dikirim.
Jalan
Harus dijelaskan dengan baik @DefaultConfig atau @ConfigDir. Tergantung pada penjelasan yang diberikan ini akan berisi referensi jalan ke plugin default config file atau direktori yang digunakan untuk menyimpan file-file konfigurasi.
PluginContainer
A :javadoc: Plugin pembungkus kelas, digunakan untuk mengambil informasi dari anotasi untuk digunakan lebih mudah.
PluginManager
Mengelola plugin yang dimuat oleh implementasi. Dapat mengambil plugin lain PluginContainer.

Injeksi Contoh

Ada beberapa referensi yang sulit untuk mendapatkan - atau, dalam beberapa kasus, mungkin - tanpa injeksi. Sementara ini mungkin tidak benar-benar penting untuk setiap plugin, mereka cukup sering digunakan.

Catatan

Ingat bahwa itu almost always praktik terbaik untuk inject anda benda-benda di dalam kelas utama, karena itu diturunkan dengan Guice injector ketika plugin ini dimuat.

Logger

Tip

Lihat :doc: `logging`untuk panduan lengkap, khusus untuk Logger.

Permainan

Objek Permainan adalah pembukaan untuk banyak fungsi internal SpongeAPI, dari EventManager untuk Server dan bahkan Sinkronisasi/Async Scheduler.

Sangat mungkin untuk menerima objek Game dari dalam sebagian besar even, namun biasanya diperoleh melalui suntikan.

Example - Field

import com.google.inject.Inject;
import org.spongepowered.api.Game;

@Inject
private Game game;

Example - Method

private Game game;

@Inject
private void setGame(Game game) {
    this.game = game;
}

Example - Constructor

For the purpose of this tutorial, "Apple" is the class name.
private Game game;

@Inject
public Apple(Game game) {
    this.game = game;
}

Direktori Config

Cara yang disarankan untuk mendapatkan config melalui Guice, bersama dengan :javadoc: ConfigDir anotasi.

Tip

Jika anda mengatur sharedRoot untuk true,anda ConfigDir akan menjadi direktori yang sama yang - berpotensi - rumah konfigurasi untuk plugin lainnya. Dalam kebanyakan kasus di mana meraih``ConfigDir`` is required, this should be false.

Example - Field

import org.spongepowered.api.config.ConfigDir;

import java.nio.file.Path;

@Inject
@ConfigDir(sharedRoot = false)
private Path configDir;

Example - Method

private Path configDir;

@Inject
@ConfigDir(sharedRoot = false)
private void setConfigDir(Path configDir) {
    this.configDir = configDir;
}

Example - Constructor

Untuk tujuan dari tutorial ini, "jeruk" adalah nama kelas.
private Path configDir;

@Inject
public Orange(@ConfigDir(sharedRoot = false) Path configDir) {
    this.configDir = configDir;
}

DefaultConfig

The way that @DefaultConfig works is very similar to @ConfigDir. The biggest difference obviously being that @DefaultConfig refers to a specific file, where @ConfigDir refers to a directory.

Tip

Lihat :doc: configuration/index untuk panduan lengkap, spesial untuk @DefaultConfig.