IT技術 副業

システム方式設計:「ファイルアクセス方式」の書き方

IT技術
おく
おく

システム方式設計書(アプリケーション方式設計書)にはどんなことを書いたらいいのでしょうか。
必要だから、仕事のルールだからとりあえず作った。
と、いう人は多いのではないでしょうか。
せっかく作ったのに、作って終わりではもったいないです。
役に立たせたいですよね。
そのために、何を書いたらいいのか答えます。
今回はファイルアクセス方式についてです。

ファイルアクセス方式に書くこと

ファイルアクセス方式はシステムでファイルを扱う場合に設計する項目です。
システムの中でエクセルファイルを作ったりCSVファイルを作ることがあります。
このような処理で必要なことを設計していきます。

帳票処理方式との区別で迷うかもしれません。
明確な使い分けはありません。
ミドルウェアなどのツールを使って出す場合は帳票処理方式でもいいでしょう。
ファイル作成の制御をツールに任せるか、自分で決めるところが多いか?いう感じでもいいです。

次にファイル出力方式で記載する要素を挙げます。
これらの設計が必要な場合はファイルアクセス方式、ミドルウェアやツールにお任せする要素が多い場合は帳票処理方式でいいでしょう。

ファイルアクセス方式に書く要素

では、ファイルアクセス方式はどのようなことを書いたらいいのか、一例を挙げていきます。

・作成するファイルの形式(CSV、XMLなどのファイル種別)
・出力するファイルのフォーマット
・ファイルの読み込み、書き出しの時の仕組み(利用部品などを明確にする)

ファイルアクセス方式の中の各章にはどのようなことを書いたらいいのか説明していきます。
各章の中の構成につては過去記事をご覧ください。

ファイルアクセス方式の「概要」

ファイルアクセス方式の概要には読み書きするファイルについての要件を書くといいでしょう。
どんなファイルを扱うのか、どのような頻度、作成数、ファイル最大サイズなどオーナーからの要件を整理します。

ファイルについての要件から次の方式設計の章を作成していきます。

ファイルアクセス方式の「方式設計」

「方式設計」の章は仕組みを説明する章です。
しかし、ファイルアクセス方式の場合は少し違います。
仕組みよりは制約事項を明らかにしていくことが多いです。
具体的に例を挙げてみます。

ファイルフォーマット

扱うファイルごとに、ファイルの中のフォーマットを決めます。
例えば、CSVファイルはファイルフォーマットが曖昧です。
カンマ区切りの可変長とするのか、固定長とするのか。
日本語や記号を含む場合は”(セミコロン)で囲むのかなどです。

そのほかにも独自のフォーマットを扱う場合は仕様を明確にします。

文字コード

テキストファイルを扱う場合は文字コードを明確しておく必要があります。

ファイルチェック

ファイル読み込みの場合に検討することが多いです。
読み込んだファイルのフォーマットをチェックします。
必要であれば設計します。
どのようなチェックをするのかを決めます。

0バイト時の処理

出力するファイルに出力するデータがない場合の扱いを決めます。
0バイトでファイルを出力するのかなど決めます。

処理の流れ

ファイルの読み書きに利用する部品などを決めます。

ファイルアクセス方式の「実装方式」

ファイルの読み込み、書き出しをする場合に使う部品の使い方。
出力するデータの渡し方などの実装方法を開発者に向けて説明します。
ファイルの読み書きはプログラム言語標準でも多数用意されているので、どの部品を使うかを決めます。
開発者ごとに異なるプログラムを書かないように実装例なども記載するといいでしょう。

コメント

タイトルとURLをコピーしました