C言語+MySQL入門|商品登録関数を呼び出す

C言語+MySQL入門|商品登録関数を呼び出す

前の記事では、登録ボタンを押した時点の商品名と単価を取得し、ProductInputへまとめました。

今回は、そのデータを既存の商品登録関数へ渡し、実際にMySQLへ商品を登録します。

GUI版でも、商品登録用のSQLを画面側へ書き直す必要はありません。第12章までに作成したregister_productを、そのまま利用しましょう。

この記事では、次の内容を詳しく解説します。

  • 商品登録に必要なDBモジュールを配置する。
  • 起動時にDBへ接続し、その接続をGUIから利用する。
  • ProductInputをregister_productへ渡す。
  • 登録結果と採番された商品IDを受け取る。
  • 業務結果と、接続を継続利用できるかどうかを分けて確認する。
  • ウィンドウを閉じた後にDB接続を終了する。

今回は、商品登録と基本的な結果表示までを作成します。商品一覧の取得や、登録後の入力欄のクリアは、後の記事で追加していきます。

GUIから既存のDB関数を呼び出そう

第12章までに作成した商品登録関数は、次の形で公開されています。

AppResult register_product(
    MYSQL *conn,
    const ProductInput *input,
    int *new_product_id
);

GUI側から渡すものと、受け取るものを確認しましょう。

引数・戻り値役割
conn接続済みのDB接続
input商品名と単価をまとめた入力データ
new_product_id確定した商品IDの保存先
AppResult業務結果、接続の継続可否、診断情報

GUI側では、14.4で作成したcollect_product_inputを使って入力データを用意します。

その後、同じコールバックの中でregister_productを呼び出します。

画面は入力と表示を担当し、DB関数は登録と確定を担当するという役割分担を引き継ぎましょう。

商品登録関数が担当する処理を確認しよう

既存のregister_productには、次の処理が含まれています。

  • 商品名と単価の検証。
  • プリペアドステートメントの準備。
  • 入力値の結び付け。
  • トランザクションの開始。
  • INSERTの実行。
  • 登録件数と商品IDの確認。
  • COMMITによる確定。
  • 失敗時のROLLBACK。
  • ステートメントの後片付け。

そのため、GUI側で追加のトランザクションを開始したり、関数を呼び出した後にCOMMITしたりする必要はありません。

GUI側は、登録関数が返したAppResultを確認します。

図1:GUIから共通の商品登録関数を呼び出す

この図から分かること

GUIは、接続と商品登録用データを共通関数へ渡します。

商品登録関数がDB操作と確定を担当し、GUIは返された結果を画面へ表示します。

コンソール版で作成したDB処理を、同じ型と関数で利用できます。

商品登録に必要なファイルを配置しよう

14.4までは、画面と共通の入力検証だけを使用していました。

今回は、第13章へ引き継いだDBモジュールから、接続、設定読み込み、商品登録に必要なファイルを配置します。

MSYS2 UCRT64で、chap14へ移動してください。

cd /c/c-mysql/chap14

保存先を用意します。

mkdir -p gui include src/db src/product src/common

まず、コピー元を確認します。

ls ../chap13/include/app_result.h \
  ../chap13/include/db.h \
  ../chap13/include/db_config.h \
  ../chap13/include/product.h \
  ../chap13/src/db/db.c \
  ../chap13/src/db/db_config.c \
  ../chap13/src/product/product.c \
  ../chap13/inventory.conf

初回の配置では、次のコマンドでコピーします。

cp ../chap13/include/app_result.h \
  ../chap13/include/db.h \
  ../chap13/include/db_config.h \
  ../chap13/include/product.h \
  include/
cp ../chap13/src/db/db.c \
  ../chap13/src/db/db_config.c \
  src/db/
cp ../chap13/src/product/product.c src/product/
cp ../chap13/inventory.conf .

コピー先に同じファイルがある場合は、その内容を確認してください。chap14で変更済みのファイルを、繰り返しコピーして上書きする必要はありません。

今回使用する主なファイルは、次のとおりです。

ファイル役割
include/app_types.hProductInputなどの型
include/app_result.hAppResultと診断情報
include/db.h接続関数と接続エラー情報
include/db_config.h接続設定と読み込み関数
include/product.h商品操作関数の宣言
include/validation.h入力検証関数の宣言
src/db/db.cDBへの接続
src/db/db_config.c設定ファイルの読み込み
src/product/product.c商品登録
src/common/validation.c共通の入力検証
inventory.confパスワード以外の接続設定
gui/inventory_register.c今回作成するGUI

app_types.hと検証ファイルは、前の記事までに配置したものを使用します。

接続設定とパスワードを分けて扱おう

inventory.confは、これまでと同じ形式です。

実際の接続先に合った値を使用してください。

パスワード以外の接続設定を保存するファイル

ファイル名: inventory.conf

# パスワードは、このファイルへ記載しません
host=127.0.0.1
port=3306
database=inventory_db
user=inventory_user

パスワードは設定ファイルへ記載せず、起動スクリプトで受け取ります。

また、第13章と同じく、接続はmainが作成し、終了時に閉じます。

担当接続に対して行うこと
main接続を作成し、最後に閉じる
GUIのコールバック接続を借りて登録関数を呼び出す
register_product接続を借りて登録し、自分のステートメントを閉じる

登録結果と接続状態を別々に確認しよう

DB操作を組み込むと、単純な成功・失敗だけでは判断できない場合があります。

特に、次の二つを分けて確認します。

確認する項目意味
result.status商品登録という操作の結果
result.connection_reusable同じ接続を次のDB操作にも使えるか

例えば、登録の確定後にステートメントの後片付けで問題が発生した場合、業務結果はAPP_OKのままです。

この場合は、登録できたことを表示したうえで、DB操作の継続を停止します。

また、APP_UNCERTAINの場合は、登録されたかどうかを確認できていません。同じ登録をすぐに繰り返さず、保存状態を確認する必要があります。

商品登録関数を呼び出すプログラムを作ろう

今回から、登録ボタンを押すと実際に商品が登録されます。

登録に成功した場合は、商品登録関数から受け取った商品IDを表示します。

商品一覧は、引き続き配置確認用の固定表示です。登録後の一覧取得は、14.7以降で追加します。

DBへ接続し、登録ボタンから共通の商品登録関数を呼び出すプログラム

ファイル名: gui/inventory_register.c

#include <gtk/gtk.h>

#include "app_types.h"
#include "db.h"
#include "db_config.h"
#include "product.h"
#include "validation.h"

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

/* 画面部品、DB接続、操作状態をまとめる */
typedef struct {
    GtkWindow *window;

    GtkEntry *name_entry;
    GtkEntry *price_entry;

    GtkLabel *name_preview;
    GtkLabel *price_preview;

    GtkButton *register_button;
    GtkButton *clear_button;

    GtkGrid *product_table;

    GtkLabel *connection_status;
    GtkLabel *message;

    int selected_product_id;

    /* 接続の作成と終了はmainが担当する */
    MYSQL *conn;
    ConnectionError connection_error;

    int db_available;
    int db_failed;
} AppUi;

/* 左寄せのラベルを作る */
static GtkWidget *create_left_label(const char *text)
{
    GtkWidget *label = gtk_label_new(text);
    gtk_label_set_xalign(GTK_LABEL(label), 0.0f);

    return label;
}

/* 入力確認用のラベルを作る */
static GtkLabel *create_preview_label(void)
{
    GtkLabel *label = GTK_LABEL(create_left_label(""));

    gtk_label_set_wrap(label, TRUE);
    gtk_label_set_wrap_mode(label, PANGO_WRAP_WORD_CHAR);
    gtk_widget_set_hexpand(GTK_WIDGET(label), TRUE);

    return label;
}

/* 配置確認用の商品表へセルを追加する */
static void add_table_cell(
    GtkGrid *grid,
    const char *text,
    int column,
    int row
)
{
    GtkWidget *label = gtk_label_new(text);
    float alignment = column >= 2 ? 1.0f : 0.0f;

    gtk_label_set_xalign(GTK_LABEL(label), alignment);

    if (column == 1) {
        gtk_widget_set_hexpand(label, TRUE);
    }

    gtk_grid_attach(grid, label, column, row, 1, 1);
}

/* 入力値やパスワードを含めず、診断情報を記録する */
static void record_error(
    const char *kind,
    const AppError *error
)
{
    if (!error->present) {
        return;
    }

    g_printerr(
        "%s:operation=%s mysql_error=%u SQLSTATE=%s\n",
        kind,
        error->operation,
        error->has_mysql_error ? error->number : 0u,
        error->sqlstate[0] != '\0' ? error->sqlstate : "-----"
    );
}

/* DB操作に使う入力欄とボタンの操作可否をそろえる */
static void set_database_controls(AppUi *ui)
{
    gtk_widget_set_sensitive(
        GTK_WIDGET(ui->name_entry),
        ui->db_available
    );

    gtk_widget_set_sensitive(
        GTK_WIDGET(ui->price_entry),
        ui->db_available
    );

    gtk_widget_set_sensitive(
        GTK_WIDGET(ui->register_button),
        ui->db_available
    );

    /* クリア処理は、後の記事で実装する */
    gtk_widget_set_sensitive(
        GTK_WIDGET(ui->clear_button),
        FALSE
    );
}

/* 起動時の接続結果を画面へ表示する */
static void show_initial_connection_result(AppUi *ui)
{
    if (ui->db_available) {
        gtk_label_set_text(
            ui->connection_status,
            "起動時の接続結果:成功"
        );

        gtk_label_set_text(
            ui->message,
            "商品名と単価を入力し、登録ボタンを押してください。\n"
            "今回から実際にDBへ商品を登録します。"
        );
    } else {
        gtk_label_set_text(
            ui->connection_status,
            "起動時の接続結果:失敗"
        );

        char *text = g_strdup_printf(
            "%s\n"
            "確認コード:%s\n"
            "DB操作はできません。\n"
            "ウィンドウを閉じ、設定やサーバーの状態を"
            "確認して起動し直してください。",
            ui->connection_error.user_message,
            ui->connection_error.display_code
        );

        gtk_label_set_text(ui->message, text);
        g_free(text);
    }

    set_database_controls(ui);
}

/* 業務結果の表示を残しながら、DB操作を停止する */
static void stop_database_actions(AppUi *ui)
{
    ui->db_available = 0;
    ui->db_failed = 1;
    ui->selected_product_id = 0;

    set_database_controls(ui);

    gtk_label_set_text(
        ui->connection_status,
        "DB操作:継続利用を停止しました。"
    );

    char *text = g_strdup_printf(
        "%s\n"
        "ウィンドウを閉じ、接続先の状態を確認してください。",
        gtk_label_get_text(ui->message)
    );

    gtk_label_set_text(ui->message, text);
    g_free(text);
}

/* 商品名の変更を受け取り、入力内容を確認する */
static void on_name_changed(
    GtkEditable *editable,
    gpointer user_data
)
{
    AppUi *ui = user_data;
    const char *name = gtk_editable_get_text(editable);

    if (name[0] == '\0') {
        gtk_label_set_text(
            ui->name_preview,
            "商品名を入力してください。"
        );
        return;
    }

    if (validate_product_name(name) != 0) {
        gtk_label_set_text(
            ui->name_preview,
            "商品名が入力条件を満たしていません。\n"
            "1〜100文字、最大400バイトで入力してください。\n"
            "空白だけの名前や制御文字は使用できません。"
        );
        return;
    }

    glong characters = g_utf8_strlen(name, -1);
    size_t bytes = strlen(name);

    char *text = g_strdup_printf(
        "入力中の商品名:%s\n"
        "文字数:%ld / 100\n"
        "バイト数:%zu / 400\n"
        "入力形式:使用できます",
        name,
        characters,
        bytes
    );

    gtk_label_set_text(ui->name_preview, text);
    g_free(text);
}

/* 単価の変更を受け取り、入力形式を確認する */
static void on_price_changed(
    GtkEditable *editable,
    gpointer user_data
)
{
    AppUi *ui = user_data;
    const char *price = gtk_editable_get_text(editable);

    if (price[0] == '\0') {
        gtk_label_set_text(
            ui->price_preview,
            "単価を入力してください。\n"
            "例:180.50"
        );
        return;
    }

    if (validate_price(price) != 0) {
        gtk_label_set_text(
            ui->price_preview,
            "単価が入力条件を満たしていません。\n"
            "整数部は半角数字で1〜8桁、"
            "小数部は省略または1〜2桁にしてください。\n"
            "符号、空白、カンマ、全角数字は使用できません。"
        );
        return;
    }

    char *text = g_strdup_printf(
        "入力中の単価:%s\n"
        "入力形式:使用できます",
        price
    );

    gtk_label_set_text(ui->price_preview, text);
    g_free(text);
}

/*
 * 現在の入力を検証して、商品登録用データへまとめる。
 * 成功した場合だけoutを書き換える。
 */
static int collect_product_input(AppUi *ui, ProductInput *out)
{
    const char *name = gtk_editable_get_text(
        GTK_EDITABLE(ui->name_entry)
    );

    const char *price = gtk_editable_get_text(
        GTK_EDITABLE(ui->price_entry)
    );

    if (validate_product_name(name) != 0) {
        gtk_label_set_text(
            ui->message,
            "商品名を確認してください。\n"
            "空欄や空白だけの名前は使用できません。\n"
            "1〜100文字、最大400バイトで入力してください。"
        );

        gtk_widget_grab_focus(GTK_WIDGET(ui->name_entry));
        return -1;
    }

    if (validate_price(price) != 0) {
        gtk_label_set_text(
            ui->message,
            "単価を確認してください。\n"
            "整数部は半角数字で1〜8桁、"
            "小数部は省略または1〜2桁で入力してください。"
        );

        gtk_widget_grab_focus(GTK_WIDGET(ui->price_entry));
        return -1;
    }

    ProductInput input = {0};

    size_t name_length = strlen(name);
    size_t price_length = strlen(price);

    if (name_length >= sizeof input.product_name ||
        price_length >= sizeof input.price) {
        gtk_label_set_text(
            ui->message,
            "登録用データを用意できませんでした。\n"
            "入力条件と保存先の配列容量を確認してください。"
        );
        return -1;
    }

    memcpy(input.product_name, name, name_length + 1);
    memcpy(input.price, price, price_length + 1);

    *out = input;
    return 0;
}

/* 登録ボタンから、既存の商品登録関数を呼び出す */
static void on_register_clicked(
    GtkButton *button,
    gpointer user_data
)
{
    (void)button;
    AppUi *ui = user_data;

    /* ボタンの状態に加え、処理の先頭でも確認する */
    if (!ui->db_available || ui->conn == NULL) {
        return;
    }

    ProductInput input = {0};

    if (collect_product_input(ui, &input) != 0) {
        return;
    }

    int new_product_id = 0;

    /* 接続と入力データを、共通の商品登録関数へ渡す */
    AppResult result = register_product(
        ui->conn,
        &input,
        &new_product_id
    );

    record_error("主処理", &result.error);
    record_error("取消処理", &result.rollback_error);
    record_error("後片付け", &result.cleanup_error);

    int stop_required = 0;

    /* まず、商品登録という業務の結果を表示する */
    switch (result.status) {
    case APP_OK: {
        char *text = g_strdup_printf(
            "商品を登録しました。\n"
            "商品ID:%d\n"
            "商品名:%s\n"
            "単価:%s\n"
            "一覧の取得と入力欄のクリアは、"
            "後の記事で追加します。",
            new_product_id,
            input.product_name,
            input.price
        );

        gtk_label_set_text(ui->message, text);
        g_free(text);
        break;
    }

    case APP_INVALID_ARGUMENT:
        gtk_label_set_text(
            ui->message,
            "商品登録関数が入力データを受け付けませんでした。\n"
            "入力条件を確認してください。"
        );
        break;

    case APP_UNCERTAIN:
        gtk_label_set_text(
            ui->message,
            "商品登録の結果を確認できませんでした。\n"
            "同じ登録を繰り返さず、"
            "DBの保存状態を確認してください。"
        );
        stop_required = 1;
        break;

    case APP_DB_ERROR:
        gtk_label_set_text(
            ui->message,
            "商品登録を完了できませんでした。\n"
            "診断情報を確認してください。"
        );
        stop_required = 1;
        break;

    default:
        gtk_label_set_text(
            ui->message,
            "商品登録を継続できません。\n"
            "処理結果を確認してください。"
        );
        stop_required = 1;
        break;
    }

    /* 次に、同じ接続でDB操作を続けられるか確認する */
    if (!result.connection_reusable || stop_required) {
        stop_database_actions(ui);
    }
}

/* 商品登録画面を作る */
static void on_activate(GtkApplication *app, gpointer user_data)
{
    AppUi *ui = user_data;

    GtkWindow *existing = gtk_application_get_active_window(app);

    if (existing != NULL) {
        gtk_window_present(existing);
        return;
    }

    ui->window = GTK_WINDOW(gtk_application_window_new(app));

    gtk_window_set_title(
        ui->window,
        "在庫管理アプリ:商品登録"
    );

    gtk_window_set_default_size(ui->window, 900, 800);

    GtkWidget *root = gtk_box_new(
        GTK_ORIENTATION_VERTICAL,
        16
    );

    gtk_widget_set_margin_top(root, 20);
    gtk_widget_set_margin_bottom(root, 20);
    gtk_widget_set_margin_start(root, 20);
    gtk_widget_set_margin_end(root, 20);

    gtk_window_set_child(ui->window, root);

    GtkWidget *heading = create_left_label(
        "商品の登録と一覧表示"
    );
    gtk_box_append(GTK_BOX(root), heading);

    ui->connection_status = GTK_LABEL(create_left_label(""));
    gtk_label_set_wrap(ui->connection_status, TRUE);

    gtk_box_append(
        GTK_BOX(root),
        GTK_WIDGET(ui->connection_status)
    );

    /* 商品名と単価、その確認結果を配置する */
    GtkWidget *form = gtk_grid_new();

    gtk_grid_set_row_spacing(GTK_GRID(form), 12);
    gtk_grid_set_column_spacing(GTK_GRID(form), 16);

    GtkWidget *name_label = create_left_label("商品名");
    GtkWidget *price_label = create_left_label("単価");

    ui->name_entry = GTK_ENTRY(gtk_entry_new());
    ui->price_entry = GTK_ENTRY(gtk_entry_new());

    gtk_entry_set_placeholder_text(
        ui->name_entry,
        "例:GUI登録確認ノート"
    );
    gtk_entry_set_max_length(ui->name_entry, 100);

    gtk_entry_set_placeholder_text(
        ui->price_entry,
        "例:180.50"
    );

    gtk_entry_set_input_purpose(
        ui->price_entry,
        GTK_INPUT_PURPOSE_NUMBER
    );
    gtk_entry_set_alignment(ui->price_entry, 1.0f);

    gtk_widget_set_hexpand(
        GTK_WIDGET(ui->name_entry),
        TRUE
    );
    gtk_widget_set_hexpand(
        GTK_WIDGET(ui->price_entry),
        TRUE
    );

    gtk_label_set_mnemonic_widget(
        GTK_LABEL(name_label),
        GTK_WIDGET(ui->name_entry)
    );
    gtk_label_set_mnemonic_widget(
        GTK_LABEL(price_label),
        GTK_WIDGET(ui->price_entry)
    );

    ui->name_preview = create_preview_label();
    ui->price_preview = create_preview_label();

    gtk_grid_attach(
        GTK_GRID(form), name_label, 0, 0, 1, 1
    );
    gtk_grid_attach(
        GTK_GRID(form),
        GTK_WIDGET(ui->name_entry),
        1, 0, 1, 1
    );
    gtk_grid_attach(
        GTK_GRID(form),
        GTK_WIDGET(ui->name_preview),
        1, 1, 1, 1
    );

    gtk_grid_attach(
        GTK_GRID(form), price_label, 0, 2, 1, 1
    );
    gtk_grid_attach(
        GTK_GRID(form),
        GTK_WIDGET(ui->price_entry),
        1, 2, 1, 1
    );
    gtk_grid_attach(
        GTK_GRID(form),
        GTK_WIDGET(ui->price_preview),
        1, 3, 1, 1
    );

    gtk_box_append(GTK_BOX(root), form);

    /* 登録ボタンと、未実装のクリアボタン */
    GtkWidget *button_box = gtk_box_new(
        GTK_ORIENTATION_HORIZONTAL,
        12
    );

    ui->register_button = GTK_BUTTON(
        gtk_button_new_with_label("商品を登録")
    );
    ui->clear_button = GTK_BUTTON(
        gtk_button_new_with_label("入力欄をクリア")
    );

    gtk_box_append(
        GTK_BOX(button_box),
        GTK_WIDGET(ui->register_button)
    );
    gtk_box_append(
        GTK_BOX(button_box),
        GTK_WIDGET(ui->clear_button)
    );
    gtk_box_append(GTK_BOX(root), button_box);

    /* この一覧は、まだDBから取得していない */
    GtkWidget *list_heading = create_left_label(
        "商品一覧(配置確認用の固定データ)"
    );
    gtk_box_append(GTK_BOX(root), list_heading);

    GtkWidget *scroll = gtk_scrolled_window_new();

    gtk_scrolled_window_set_policy(
        GTK_SCROLLED_WINDOW(scroll),
        GTK_POLICY_AUTOMATIC,
        GTK_POLICY_AUTOMATIC
    );
    gtk_scrolled_window_set_has_frame(
        GTK_SCROLLED_WINDOW(scroll),
        TRUE
    );

    gtk_widget_set_vexpand(scroll, TRUE);
    gtk_widget_set_hexpand(scroll, TRUE);

    ui->product_table = GTK_GRID(gtk_grid_new());

    gtk_grid_set_row_spacing(ui->product_table, 12);
    gtk_grid_set_column_spacing(ui->product_table, 24);

    GtkWidget *table = GTK_WIDGET(ui->product_table);

    gtk_widget_set_margin_top(table, 12);
    gtk_widget_set_margin_bottom(table, 12);
    gtk_widget_set_margin_start(table, 12);
    gtk_widget_set_margin_end(table, 12);

    gtk_widget_set_hexpand(table, TRUE);
    gtk_widget_set_valign(table, GTK_ALIGN_START);

    const char *headers[] = {
        "商品ID",
        "商品名",
        "単価",
        "在庫数"
    };

    /* 実行時のDBの内容とは連動しない固定データ */
    const char *example[] = {
        "23",
        "入庫確認ノート",
        "180.50",
        "5"
    };

    for (int column = 0; column < 4; ++column) {
        add_table_cell(
            ui->product_table,
            headers[column],
            column,
            0
        );
        add_table_cell(
            ui->product_table,
            example[column],
            column,
            1
        );
    }

    gtk_scrolled_window_set_child(
        GTK_SCROLLED_WINDOW(scroll),
        table
    );
    gtk_box_append(GTK_BOX(root), scroll);

    GtkWidget *message_heading = create_left_label(
        "メッセージ"
    );
    gtk_box_append(GTK_BOX(root), message_heading);

    ui->message = create_preview_label();
    gtk_box_append(
        GTK_BOX(root),
        GTK_WIDGET(ui->message)
    );

    /* 表示先を作った後で、コールバックを登録する */
    g_signal_connect(
        ui->name_entry,
        "changed",
        G_CALLBACK(on_name_changed),
        ui
    );
    g_signal_connect(
        ui->price_entry,
        "changed",
        G_CALLBACK(on_price_changed),
        ui
    );
    g_signal_connect(
        ui->register_button,
        "clicked",
        G_CALLBACK(on_register_clicked),
        ui
    );

    on_name_changed(GTK_EDITABLE(ui->name_entry), ui);
    on_price_changed(GTK_EDITABLE(ui->price_entry), ui);

    show_initial_connection_result(ui);

    gtk_window_present(ui->window);
}

/* 設定読み込み、接続、GUI実行、接続終了を担当する */
int main(int argc, char *argv[])
{
    int check_only = 0;

    if (argc == 2 && strcmp(argv[1], "--check-config") == 0) {
        check_only = 1;
    } else if (argc != 1) {
        fputs(
            "使い方:\n"
            "  inventory_register.exe\n"
            "  inventory_register.exe --check-config\n",
            stderr
        );
        return EXIT_FAILURE;
    }

    DbConfigStorage storage = {0};
    char reason[512] = {0};

    if (load_db_config(
            "inventory.conf",
            &storage,
            reason,
            sizeof reason) != 0) {
        fprintf(
            stderr,
            "接続設定を読み込めませんでした。\n%s\n",
            reason
        );
        return EXIT_FAILURE;
    }

    /* 設定確認時には、接続もGUI起動も行わない */
    if (check_only) {
        puts("設定の検証が完了しました。");
        puts("MySQLへは接続していません。");
        return EXIT_SUCCESS;
    }

    DbConfig config = {
        .host = storage.host,
        .port = storage.port,
        .database = storage.database,
        .user = storage.user
    };

    AppUi ui = {0};

    ui.conn = connect_database(
        &config,
        getenv("INVENTORY_DB_PASSWORD"),
        &ui.connection_error
    );

    ui.db_available = ui.conn != NULL;
    ui.db_failed = !ui.db_available;

    if (ui.db_available) {
        puts(
            "MySQLへの接続を確認しました。"
            "GUIを起動します。"
        );
    } else {
        /* 接続に失敗しても、結果をGUIへ表示する */
        g_printerr(
            "DB接続に失敗しました。\n"
            "%s\n確認コード:%s\n"
            "接続段階:%s MySQLエラー:%u SQLSTATE:%s\n",
            ui.connection_error.user_message,
            ui.connection_error.display_code,
            ui.connection_error.stage,
            ui.connection_error.number,
            ui.connection_error.sqlstate
        );
    }

    GtkApplication *app = gtk_application_new(
        "org.example.InventoryRegister",
        G_APPLICATION_DEFAULT_FLAGS
    );

    g_signal_connect(
        app,
        "activate",
        G_CALLBACK(on_activate),
        &ui
    );

    int status = g_application_run(
        G_APPLICATION(app),
        argc,
        argv
    );

    /* 成功時に受け取った接続だけを閉じる */
    if (ui.conn != NULL) {
        mysql_close(ui.conn);
        ui.conn = NULL;
        puts("DB接続を終了しました。");
    }

    g_object_unref(app);

    return ui.db_failed ? EXIT_FAILURE : status;
}

図2:接続の作成・利用・終了を分担する

この図から分かること

接続を作成する処理と、接続を終了する処理はmainへまとめています。

GUIのコールバックと商品登録関数は、その接続を借りて使用します。

商品登録のたびに接続を閉じたり、複数の担当が同じ接続を解放したりする構成にはしていません。

GTK 4とConnector/Cを指定してビルドしよう

gui/inventory_register.cをUTF-8で保存してください。

今回は、GUIに加えてDB接続と商品登録を使用します。そのため、GTK 4とConnector/Cの両方を指定します。

cd /c/c-mysql/chap14
gcc -std=c17 -Wall -Wextra -Wpedantic \
  -Iinclude \
  gui/inventory_register.c \
  src/db/db.c \
  src/db/db_config.c \
  src/product/product.c \
  src/common/validation.c \
  -o inventory_register.exe \
  $(pkg-config --cflags --libs gtk4 mysqlclient)

ビルド対象を確認しましょう。

ソースファイル内容
gui/inventory_register.cGUI、接続管理、登録関数の呼び出し
src/db/db.c接続処理
src/db/db_config.c設定の読み込み
src/product/product.c商品登録
src/common/validation.c入力検証

今回は商品登録だけを呼び出すため、商品一覧や商品変更のソースは指定していません。

product.hにほかの商品操作の宣言があっても、呼び出していない関数の実装まで、今回の実行ファイルへ組み込む必要はありません。

以前のGUI側のソースは、今回のビルド対象へ追加しないようにしましょう。

設定だけを確認する場合は、次のように実行できます。

./inventory_register.exe --check-config

実行結果の例

設定の検証が完了しました。
MySQLへは接続していません。

この実行では、DB接続もウィンドウの表示も行いません。

パスワードを受け取る起動スクリプトを作ろう

第13章と同じ方法で、パスワードを画面へ表示せずに受け取ります。

起動スクリプトは、自分が保存されているchap14へ移動してから実行します。これにより、inventory.confを読み込む場所もそろえられます。

設定確認とパスワード入力を行い、商品登録GUIを起動するスクリプト

ファイル名: run_gui_register.sh

#!/usr/bin/env bash

set -u

# スクリプトを保存したchap14を作業場所にする
cd -- "$(dirname -- "${BASH_SOURCE[0]}")" || exit 1

# ビルド済みの実行ファイルを確認する
if [[ ! -f inventory_register.exe ]]; then
    printf "inventory_register.exeがありません。先にビルドしてください。\n" >&2
    exit 1
fi

# パスワード入力前に、設定ファイルを確認する
if ! ./inventory_register.exe --check-config; then
    exit 1
fi

inventory_password=""

# 入力内容を画面へ表示せずに受け取る
if ! IFS= read -r -s -p "MySQLのパスワード:" inventory_password; then
    printf "\nパスワードの入力を終了しました。\n" >&2
    unset inventory_password
    exit 1
fi

printf "\n"

if [[ -z "$inventory_password" ]]; then
    printf "パスワードが入力されていません。\n" >&2
    unset inventory_password
    exit 1
fi

# 今回起動するアプリへ環境変数として渡す
INVENTORY_DB_PASSWORD="$inventory_password" ./inventory_register.exe
result_status=$?

# シェル側の変数設定を解除する
unset inventory_password

exit "$result_status"

MySQL Serverが起動していることを確認し、次のコマンドで実行してください。

bash run_gui_register.sh

実行結果の例

接続に成功すると、ターミナルには次のように表示されます。

設定の検証が完了しました。
MySQLへは接続していません。
MySQLのパスワード:
MySQLへの接続を確認しました。GUIを起動します。

ウィンドウには、次の接続結果が表示されます。

起動時の接続結果:成功

メッセージ欄には、次の案内が表示されます。

商品名と単価を入力し、登録ボタンを押してください。
今回から実際にDBへ商品を登録します。

商品を一件登録してみよう

確認用として、次の内容を入力します。

項目入力内容
商品名GUI登録確認ノート
単価180.50

入力後、商品を登録ボタンを一度押してください。

実行結果の例

ここでは、採番された商品IDが27だった場合を表示例として示します。実際には、画面へ表示された商品IDを使用してください。

商品を登録しました。
商品ID:27
商品名:GUI登録確認ノート
単価:180.50
一覧の取得と入力欄のクリアは、後の記事で追加します。

今回は、登録に成功しても入力欄を残しています。

同じ内容で再びボタンを押すと、もう一件の新規登録になります。保存結果の確認には、表示された商品IDを使いましょう。

登録関数へ渡している三つの値を確認しよう

今回の中心となる呼び出しです。

int new_product_id = 0;

AppResult result = register_product(
    ui->conn,
    &input,
    &new_product_id
);
渡す値内容
ui->connmainが作成した接続
&input商品名と単価を保持するProductInput
&new_product_id確定した商品IDを書き込む場所

inputは、コールバックのローカル変数です。

register_productは、この呼び出しの中で処理を完了してから戻るため、入力データは関数の実行中も有効です。

また、GUI側で入力を検証していても、商品登録関数側の検証は残します。DB関数自身も、渡された値を確認する設計を引き継いでいます。

商品IDを受け取っただけで判断しないようにしよう

既存のregister_productは、内部でmysql_stmt_insert_idを使って採番値を取得します。このC APIは、プリペアドステートメントによって生成されたAUTO_INCREMENT値を取得するための関数です。

ただし、内部で採番値を取得した時点と、登録が確定した時点は別です。

今回利用しているregister_productでは、COMMITの成功を確認した後に、new_product_idへ値を保存します。

mysql_commitの戻り値は、成功時が0、エラー時が0以外です。

GUI側では、AppResultのstatusがAPP_OKの場合に、受け取った商品IDを表示しています。

case APP_OK: {
    char *text = g_strdup_printf(
        "商品を登録しました。\n"
        "商品ID:%d\n"
        "商品名:%s\n"
        "単価:%s\n"
        "一覧の取得と入力欄のクリアは、"
        "後の記事で追加します。",
        new_product_id,
        input.product_name,
        input.price
    );

    gtk_label_set_text(ui->message, text);
    g_free(text);
    break;
}

商品IDを23や24に固定して扱うのではなく、登録関数が返した値を使用します。

業務結果を表示してから、接続の継続可否を確認する

今回のコールバックでは、最初にstatusに応じた結果を表示しています。

その後で、次の条件を確認します。

if (!result.connection_reusable || stop_required) {
    stop_database_actions(ui);
}

この順序にすることで、登録成功後に後片付けの問題が発生した場合も、成功した事実を残せます。

状態GUIでの扱い
APP_OKで接続も利用可能登録成功を表示し、操作を続ける
APP_OKで接続利用不可登録成功を表示し、DB操作を停止する
APP_UNCERTAIN結果不明を案内し、DB操作を停止する
APP_DB_ERROR登録を完了できなかったことを案内し、DB操作を停止する

APP_OKなのにconnection_reusableが0だった場合、登録した商品を取り消したことにはなりません。

確定済みの登録と、接続の継続利用を別々に扱っています。

図3:登録成功・結果不明・接続利用停止を区別する

この図から分かること

商品登録の結果と、接続を使い続けられるかどうかは別の情報です。

登録成功後に接続の利用を止める場合でも、登録成功の表示を保持します。

結果不明の場合は、自動的に同じ登録をやり直さず、DBの保存状態を確認します。

接続できない場合は登録操作を止める

起動時に接続できなかった場合も、第13章と同じくウィンドウを表示します。

ただし、商品名と単価の入力欄、登録ボタンは操作できない状態にします。

gtk_widget_set_sensitive(
    GTK_WIDGET(ui->register_button),
    ui->db_available
);

gtk_widget_set_sensitiveへFALSEを渡すと、利用者がその部品を操作できなくなります。

コールバックの先頭でも、操作可能な状態かどうかを確認しています。

if (!ui->db_available || ui->conn == NULL) {
    return;
}

画面上の操作可否と、処理を開始する条件をそろえています。

接続結果の表示は、起動時に確認した結果です。その後の通信状態は、実際のDB操作が返すAppResultから判断します。

SQLで保存結果を確認しよう

今回の画面内の商品一覧は、固定表示のままです。

登録できたことは、メッセージ欄と、MySQLクライアントからのSELECTで確認します。

表示された商品IDが27だった場合は、inventory_dbを使用するMySQLクライアントで、次のSQLを実行してください。

SELECT
    product_id,
    product_name,
    price,
    stock
FROM products
WHERE product_id = 27;

実際の確認では、27を画面に表示された商品IDへ置き換えます。

実行結果の例

+------------+--------------------------+--------+-------+
| product_id | product_name             | price  | stock |
+------------+--------------------------+--------+-------+
|         27 | GUI登録確認ノート        | 180.50 |     0 |
+------------+--------------------------+--------+-------+
1 row in set (0.00 sec)

商品名と単価が保存され、在庫数が0になっていることを確認します。

今回の処理は商品登録です。入庫を行ったわけではないため、在庫数の加算や入庫履歴の登録は行いません。

ウィンドウを閉じた後に接続を終了する

ウィンドウを閉じ、g_application_runから戻った後に、mainが接続を閉じます。

if (ui.conn != NULL) {
    mysql_close(ui.conn);
    ui.conn = NULL;
    puts("DB接続を終了しました。");
}

mysql_closeは、接続を閉じ、接続ハンドルに割り当てられたメモリを解放します。

接続に失敗した場合、connect_databaseは途中の資源を片付けてNULLを返します。そのため、mainは成功時に受け取った接続だけを閉じます。

また、操作途中でconnection_reusableが0になった場合も、その後のDB操作を止め、最後の接続終了はmainで行います。

実行結果の例

ウィンドウを閉じると、接続を保持していた場合はターミナルへ次のように表示されます。

DB接続を終了しました。

通常の登録と終了を確認できたら、入力エラーの場合に登録されないことも試してください。

  • 商品名を空欄にして登録ボタンを押す。
  • 商品名を空白だけにして登録ボタンを押す。
  • 単価を180.500にして登録ボタンを押す。
  • 単価を180.50へ修正して登録する。

GUI側の入力検証に失敗した場合は、register_productを呼び出す前に処理を終了します。

商品登録関数への受け渡しと保存結果を確認できたら、次の14.6では、成功・入力エラー・DBエラーの案内を整理し、登録結果をさらに分かりやすく表示していきましょう。

Follow me!