この記事は Rust Advent Calendar 2023 シリーズ2 の6日目の記事です。
はじめに
Rustでの開発で、ディレクトリやファイルの分割に関するお話です。
Rustでは、ディレクトリやファイルがモジュールとして扱われます。
Rustのモジュールは、よくわからず色々調べて回ったところなので、備忘録を兼ねてまとめておきます。
ステップバイステップで書いていこうと思っています。
誰かの役に立てたら嬉しいな。
リポジトリはこちらです。
https://github.com/TakedaTakumi/rust-module-sample
筆者はTypeScriptをよく使っているので、その辺の用語が混ざっているかもしれませんが、ご容赦ください。
Step01: モジュールを使わない
まずは、モジュールを使わないでコードを書いてみます。
最初の構成はこんな感じです。
.
├── Cargo.toml
└── src
└── main.rs
src/main.rsに以下のコードを書きます。
#[derive(Debug)]
struct ID {
value: String,
}
impl ID {
fn new(value: &str) -> Self {
Self {
value: value.to_string(),
}
}
}
#[derive(Debug)]
struct Node {
id: ID,
label: String,
}
impl Node {
fn new(id: ID, label: &str) -> Self {
Self {
id,
label: label.to_string(),
}
}
}
fn main() {
let node = Node::new(ID::new("1"), "Node 1");
println!("Hello, module: {:?}", node);
}
実行すると、こうなります。
Hello, module: Node { id: ID { value: "1" }, label: "Node 1" }
このコードは、ドメイン駆動設計（DDD）を想定して、ドメイン層としてNodeエンティティと、そのID値を表すID値オブジェクトを定義しています。
Nodeエンティティのlabelプロパティが値オブジェクトになっていないのは、ちょっと目をつぶってください。
コードが長くなってしまうので、意図的に手を抜いています。
このコードをもとに、ファイル分割をしていきましょう。
Step02: ファイル分割
NodeやIDをそれぞれ別ファイルにしてみましょう。
こんな風に分けて見ました。
.
├── Cargo.toml
└── src
├── id.rs # 追加
├── main.rs
└── node.rs # 追加
各ファイルの中身はこのような感じです。
構造体や関数を公開するために、pubをつけています。
#[derive(Debug)]
pub struct ID {
value: String,
}
impl ID {
pub fn new(value: &str) -> Self {
Self {
value: value.to_string(),
}
}
}
node.rsでは、id.rsをインポートしています。
use crate::id::ID;
#[derive(Debug)]
pub struct Node {
id: ID,
label: String,
}
impl Node {
pub fn new(id: ID, label: &str) -> Self {
Self {
id,
label: label.to_string(),
}
}
}
1行目はmodと同じく、TypeScriptでいうところのimportであるuseです。
modとの違いは、モジュールではなく、構造体をインポートするということです。
意味としては、「crate直下のidモジュール内のID構造体を使用可能にする」というところでしょうか。
ファイル名がモジュール名になるので、このようになります。
このファイルをmain.rsからインポートします。
こんな感じ。
mod node; // node.rsをインポート
mod id; // id.rsをインポート
fn main() {
let node = node::Node::new(id::ID::new("1"), "Node 1");
println!("Hello, module: {:?}", node);
}
1行目と2行目で、それぞれのファイルをインポートしています。
ここでは、useの代わりに、modを使った例を示します。
これでnodeモジュールとidモジュールが使えるようになりました。
5行目については「nodeモジュール内のNode構造体のnewスタティック関数を実行する～」のような意味になります。
Step03: ディレクトリ分割
次に、ディレクトリ分割をしてみましょう。
今のままでは、エンティティや値オブジェクトが増えるたびに管理が難しくなるので、種類ごとにディレクトリ分けしましょう。
こんな構成にしてみました。
.
├── Cargo.toml
└── src
├── domain # 追加
│ ├── entity # 追加
│ │ └── node.rs ## 移動
│ └── value_object # 追加
│ └── id.rs ## 移動
└── main.rs
しかし、このままではnodeやidのモジュール（rsファイル）を認識してくれません。
Rustでは、ディレクトリもモジュールになるわけですが、モジュールとして認識させるためには、ディレクトリと同名のrsファイルが必要になります。
こうなります。
.
├── Cargo.toml
└── src
├── domain
│ ├── entity
│ │ └── node.rs
│ ├── entity.rs # 追加
│ ├── value_object
│ │ └── id.rs
│ └── value_object.rs # 追加
├── domain.rs # 追加
└── main.rs
それぞれのファイルでは、下位のモジュールをインポートしてエクスポートするように記載します。
TypeScriptでいう、export AAA from 'XXX'のようなイメージです。
pub mod XXXと書きます。
pub mod id;
pub mod node;
pub mod entity;
pub mod value_object;
node.rsもインポートしているIDの場所が変わったので、修正します。
増えたディレクトリ分だけモジュールを追加しましょう。
use crate::domain::value_object::id::ID; // ここを修正
#[derive(Debug)]
pub struct Node {
id: ID,
label: String,
}
impl Node {
pub fn new(id: ID, label: &str) -> Self {
Self {
id,
label: label.to_string(),
}
}
}
この調子でmain.rsも修正しましょう。
mod domain;
use domain::{entity::node::Node, value_object::id::ID};
fn main() {
let node = Node::new(ID::new("1"), "Node 1");
println!("Hello, module: {:?}", node);
}
構造体を使用するたびにモジュールまで書いているとやってられないので、useを使ってインポートしています。
モジュールに共通部分がある場合、このような書き方もできます。
さて、ファイル分割と、ディレクトリ分割が上手くいったので、ここで終わらせてしまってもいいんですが、上のコード、ちょっと気になりませんか？
私はとっても気になります！
この部分です。
use domain::{entity::node::Node, value_object::id::ID};
domainやentity, value_objectまではいいんですが、nodeやidって、なんか冗長だなぁと思うんですよ。
いらんだろ、と。
公式（の非公式和訳）には詳しく書いてなかったんですが、方法があります！
（あとで読み返して気付いたけど、たぶん最後の「まとめ」のところに書いてあることが該当するのかな、と思ってる。読解力……！）
次のステップでは、モジュール構成をスッキリさせましょう。
Step04: モジュール構成をスッキリさせる
entity.rsなどで使用しているpub mod XXXという書き方は、XXXというモジュールをインポートして公開するという意味でした。
しかし、今回はnodeなどのモジュールは公開したくありません。
では、どうすればいいのか。
pub use XXXを使いましょう。
ディレクトリ構成はStep03のままで、各ファイルを修正します。
こんな風に修正しましょう。
mod node;
pub use node::Node;
こうするとこで、nodeモジュールは非公開にしつつ、Node構造体を公開することができます。
value_object.rsも同様に修正します。
mod id;
pub use id::ID;
これだけで、インポートしているコードはこうなります。
use crate::domain::value_object::ID;
#[derive(Debug)]
pub struct Node {
#[allow(dead_code)]
id: ID,
#[allow(dead_code)]
label: String,
}
impl Node {
pub fn new(id: ID, label: &str) -> Self {
Self {
id,
label: label.to_string(),
}
}
}
mod domain;
use domain::{entity::Node, value_object::ID};
fn main() {
let node = Node::new(ID::new("1"), "Node 1");
println!("Hello, module: {:?}", node);
}
不要なモジュールが消えてuseの部分がスッキリしましたね！
use domain::{entity::Node, value_object::ID};
これで、ディレクトリやファイル分割は自由にできるようになったかと思います。
ここで終了でもいいのですが、もう1Stepだけお付き合いください。
IDの配列を扱うことを考えてみましょう。
Step05: ID配列を管理するドメインオブジェクトを作る
IDの配列をたんにVec<ID>で扱ってもいいのですが、せっかくなので、ファーストクラスコレクションを作ってみましょう。
実装はこんな感じでしょうか。
関数は取り急ぎ、初期化のみ実装しています。
#[derive(Debug)]
pub struct IdCollection {
value: Vec<ID>,
}
impl IdCollection {
pub fn new() -> Self {
Self {
value: Vec::new(),
}
}
}
では、これをどこに置きましょうか。
IDのコレクションなんだからid.rsに書きますか。それとも、値オブジェクトを持つミュータブルなエンティティなので、entity/id_collection.rsを作りましょうか。
色々と考えられますが、現状の私の考えは以下のような構成です。
.
├── Cargo.toml
└── src
├── domain
│ ├── entity
│ │ └── node.rs
│ ├── entity.rs
│ ├── value_object
│ │ ├── id # 追加
│ │ │ ├── collection.rs # 追加
│ │ │ └── id.rs # 移動：元はvalue_object/id.rs
│ │ └── id.rs # 追加
│ └── value_object.rs
├── domain.rs
└── main.rs
ファイルが増えてしまいますが、IDとIdCollectionは近い距離の置いておきたい。でも、別ファイルにしたい。ということで、このような構成にしました。
IdCollectionは値オブジェクトではないんでは、という気もしますが、今はこれで良しとしています。
この構成の是非はあるかと思いますが、これを実現するとしたら、このように修正します。
まず、元々あったvalue_object/id.rsはvalue_object/id/id.rsに移動します。
移動するだけで、中身の変更はありません。
他はこのような感じです。
use super::ID;
#[derive(Debug)]
pub struct IdCollection {
value: Vec<ID>,
}
impl IdCollection {
pub fn new() -> Self {
Self {
value: Vec::new(),
}
}
}
IDは同一モジュールに存在するので、superで親モジュールを指定しています。
mod collection;
mod id;
pub use collection::IdCollection;
pub use id::ID;
構造体だけを公開します。
既存のファイルでは、src/domain/value_object.rsの修正が必要です。
修正と言っても、新たに追加されたIdCollectionを追加するだけです。
mod id;
pub use id::IdCollection; // 追加
pub use id::ID;
IDの場所が変わりましたが、pub useを使ってvalue_object直下にいるように見せていたので、node.rsに修正の必要はありません。
main.rsからIdCollectionを使ってみましょう。
mod domain;
use domain::{
entity::Node,
value_object::{IdCollection, ID},
};
fn main() {
let list = IdCollection::new();
let node = Node::new(ID::new("1"), "Node 1");
println!("Hello, module: {:?}", node);
println!("list: {:?}", list);
}
出力はこうなります。
Hello, module: Node { id: ID { value: "1" }, label: "Node 1" }
list: IdCollection { value: [] }
素敵ですね！
まとめ
Rustにおけるディレクトリやファイルの分割方法とモジュール構成の変更方法は以上となります。
ディレクトリ構成なんかは正解がなく、考え方は人それぞれだと思いますが、ここに書いた方法を使えば、どのようなディレクトリ構成であろうと、その構成に左右されることなくモジュールの構成を制御できるようになるかと思います。
それでは、また機会がありましたら。
良いお年をお迎えください。