データモデル

データモデルのバインディング

Wails は Go 構造体からJavaScript/TypeScript クラスを自動生成し、バックエンドとフロントエンドの間で複雑なデータを受け渡す際の完全な型安全性を実現します。Go 構造体を記述してバインディングを生成するだけで、コンストラクター、型注釈、JSDoc コメントを備えた、完全に型付けされたフロントエンドモデルを利用できます。

クイックスタート

Go 構造体：

type User struct {
    ID        int       `json:"id"`
    Name      string    `json:"name"`
    Email     string    `json:"email"`
    CreatedAt time.Time `json:"createdAt"`
}

func (s *UserService) GetUser(id int) (*User, error) {
    // Return user
}

生成：

bash

wails3 generate bindings

JavaScript：

javascript

import { GetUser } from './bindings/changeme/userservice'
import { User } from './bindings/changeme/models'

const user = await GetUser(1)
console.log(user.Name)  // Type-safe!

これだけです！ブリッジ全体で完全な型安全性が確保されます。

モデルの定義

基本的な構造体

type Person struct {
    Name string
    Age  int
}

生成された JavaScript：

javascript

export class Person {
    /** @type {string} */
    Name = ""
    
    /** @type {number} */
    Age = 0
    
    constructor(source = {}) {
        Object.assign(this, source)
    }
    
    static createFrom(source = {}) {
        return new Person(source)
    }
}

JSON タグを使用する

type User struct {
    ID        int       `json:"id"`
    Name      string    `json:"name"`
    Email     string    `json:"email"`
    CreatedAt time.Time `json:"createdAt"`
}

生成された JavaScript：

javascript

export class User {
    /** @type {number} */
    id = 0
    
    /** @type {string} */
    name = ""
    
    /** @type {string} */
    email = ""
    
    /** @type {Date} */
    createdAt = new Date()
    
    constructor(source = {}) {
        Object.assign(this, source)
    }
}

JavaScript でのフィールド名は JSON タグで制御します。

カスタム JSON マーシャリング

バインドされたメソッドの結果は、Go の標準encoding/jsonパッケージでマーシャリングされます。ポインターレシーバーで宣言されたMarshalJSONメソッドが呼び出されるのは、マーシャリング対象の値がアドレス指定可能な場合に限られることに注意してください。つまり、返されたスライスの要素に対してはカスタムマーシャラーが呼び出されますが、値として返された構造体に対しては呼び出されません。

func (n *Nullable[T]) MarshalJSON() ([]byte, error) {
    if n.Valid {
        return json.Marshal(n.V)
    }
    return []byte("null"), nil
}

func (s *UserService) GetUser() User {
    return User{} // pointer receiver may not be called
}

func (s *UserService) GetUsers() []User {
    return []User{{}} // pointer receiver is called for elements
}

一貫した出力を確保するには、その型を安全にコピーできる場合は値レシーバーにMarshalJSONを定義するか、構造体へのポインター（たとえば*User）を返してください。これは Wails のバインディング生成による違いではなく、Go のencoding/jsonの動作です。

コメントを使用する

// User represents an application user
type User struct {
    // Unique identifier
    ID int `json:"id"`
    
    // Full name of the user
    Name string `json:"name"`
    
    // Email address (must be unique)
    Email string `json:"email"`
}

生成された JavaScript：

javascript

/**
 * User represents an application user
 */
export class User {
    /**
     * Unique identifier
     * @type {number}
     */
    id = 0
    
    /**
     * Full name of the user
     * @type {string}
     */
    name = ""
    
    /**
     * Email address (must be unique)
     * @type {string}
     */
    email = ""
}

コメントが JSDoc になります！IDE にその内容が表示されます。

ネストされた構造体

type Address struct {
    Street  string `json:"street"`
    City    string `json:"city"`
    Country string `json:"country"`
}

type User struct {
    ID      int     `json:"id"`
    Name    string  `json:"name"`
    Address Address `json:"address"`
}

生成された JavaScript：

javascript

export class Address {
    /** @type {string} */
    street = ""
    
    /** @type {string} */
    city = ""
    
    /** @type {string} */
    country = ""
}

export class User {
    /** @type {number} */
    id = 0
    
    /** @type {string} */
    name = ""
    
    /** @type {Address} */
    address = new Address()
}

使用例：

javascript

const user = new User({
    id: 1,
    name: "Alice",
    address: new Address({
        street: "123 Main St",
        city: "Springfield",
        country: "USA"
    })
})

配列とスライス

type Team struct {
    Name    string   `json:"name"`
    Members []string `json:"members"`
}

生成された JavaScript：

javascript

export class Team {
    /** @type {string} */
    name = ""
    
    /** @type {string[]} */
    members = []
}

使用例：

javascript

const team = new Team({
    name: "Engineering",
    members: ["Alice", "Bob", "Charlie"]
})

マップ

type Config struct {
    Settings map[string]string `json:"settings"`
}

生成された JavaScript：

javascript

export class Config {
    /** @type {Record<string, string>} */
    settings = {}
}

使用例：

javascript

const config = new Config({
    settings: {
        theme: "dark",
        language: "en"
    }
})

型のマッピング

プリミティブ型

Go の型	JavaScript/TypeScript
`string`	`string`
`bool`	`boolean`
`int`、`int8`、`int16`、`int32`、`int64`	`number`
`uint`、`uint8`、`uint16`、`uint32`、`uint64`	`number`
`float32`、`float64`	`number`
`byte`	`number`
`rune`	`number`

複合型

Go の型	JavaScript/TypeScript	備考
`[]T`	`T[]`	-
`[N]T`	`T[]`	-
`map[string]T`	`{ [_: string]: T }`	文字列をキーとするマップ
`map[K]V`	`{ [_ in K]?: V }`	文字列以外の`K`は、JS の`Map`ではなく、マップ型としてレンダリングされます
`[]byte`	`string`	base64 エンコード済み
`struct`	`class` / `interface`	フィールドあり
`time.Time`	`any`	ランタイムでは RFC3339Nano 形式の文字列としてシリアル化
`*T`	`T \| null`	ポインターの場合は null 許容
`any` / `interface{}`	`any`	-
`error`	`any` / `Exception`	戻り値の場合は Exception、それ以外は any

サポートされていない型

chan T（チャネル）
func()（関数）
複雑なインターフェース（interface{}を除く）
非公開フィールド（小文字で始まるもの）

モデルの使用

インスタンスの作成

javascript

import { User } from './bindings/changeme/models'

// Empty instance
const user1 = new User()

// With data
const user2 = new User({
    id: 1,
    name: "Alice",
    email: "alice@example.com"
})

// From JSON string
const user3 = User.createFrom('{"id":1,"name":"Alice"}')

// From object
const user4 = User.createFrom({ id: 1, name: "Alice" })

Go への受け渡し

javascript

import { CreateUser } from './bindings/changeme/userservice'
import { User } from './bindings/changeme/models'

const user = new User({
    name: "Bob",
    email: "bob@example.com"
})

const created = await CreateUser(user)
console.log("Created user:", created.id)

Go からの受け取り

javascript

import { GetUser } from './bindings/changeme/userservice'

const user = await GetUser(1)

// user is already a User instance
console.log(user.name)
console.log(user.email)
console.log(user.createdAt.toISOString())

モデルの更新

javascript

import { GetUser, UpdateUser } from './bindings/changeme/userservice'

// Get user
const user = await GetUser(1)

// Modify
user.name = "Alice Smith"
user.email = "alice.smith@example.com"

// Save
await UpdateUser(user)

TypeScript のサポート

生成される TypeScript

bash

wails3 generate bindings -ts

生成結果：

typescript

/**
 * User represents an application user
 */
export class User {
    /**
     * Unique identifier
     */
    id: number = 0
    
    /**
     * Full name of the user
     */
    name: string = ""
    
    /**
     * Email address (must be unique)
     */
    email: string = ""
    
    /**
     * Account creation date
     */
    createdAt: Date = new Date()
    
    constructor(source: Partial<User> = {}) {
        Object.assign(this, source)
    }
    
    static createFrom(source: string | Partial<User> = {}): User {
        const parsedSource = typeof source === 'string' 
            ? JSON.parse(source) 
            : source
        return new User(parsedSource)
    }
}

TypeScript での使用

typescript

import { GetUser, CreateUser } from './bindings/changeme/userservice'
import { User } from './bindings/changeme/models'

async function example() {
    // Create user
    const newUser = new User({
        name: "Alice",
        email: "alice@example.com"
    })
    
    const created: User = await CreateUser(newUser)
    
    // Get user
    const user: User = await GetUser(created.id)
    
    // Type-safe access
    console.log(user.name.toUpperCase())  // ✅ string method
    console.log(user.id + 1)              // ✅ number operation
    console.log(user.createdAt.getTime()) // ✅ Date method
}

高度なパターン

任意フィールド

type User struct {
    ID       int     `json:"id"`
    Name     string  `json:"name"`
    Nickname *string `json:"nickname,omitempty"`
}

JavaScript：

javascript

const user = new User({
    id: 1,
    name: "Alice",
    nickname: "Ally"  // Optional
})

// Check if set
if (user.nickname) {
    console.log("Nickname:", user.nickname)
}

列挙型

バインディングジェネレーターは、定数を持つ Go の名前付き型を自動的に検出し、TypeScript の列挙型または JavaScript の const オブジェクトを生成します。これには、Go のゼロ値に対応する $zero メンバーと、完全に保持された JSDoc も含まれます。

type UserRole string

const (
    RoleAdmin UserRole = "admin"
    RoleUser  UserRole = "user"
    RoleGuest UserRole = "guest"
)

生成された TypeScript：

typescript

export enum UserRole {
    $zero = "",
    RoleAdmin = "admin",
    RoleUser = "user",
    RoleGuest = "guest",
}

使用例：

javascript

import { User, UserRole } from './bindings/changeme/models'

const admin = new User({
    name: "Admin",
    role: UserRole.RoleAdmin
})

文字列列挙型、整数列挙型、型エイリアス、インポートしたパッケージの列挙型、および制限事項について詳しくは、専用の列挙型ページを参照してください。

検証

javascript

class User {
    validate() {
        if (!this.name) {
            throw new Error("Name is required")
        }
        if (!this.email.includes('@')) {
            throw new Error("Invalid email")
        }
        return true
    }
}

// Use
const user = new User({ name: "Alice", email: "alice@example.com" })
user.validate()  // ✅

const invalid = new User({ name: "", email: "invalid" })
invalid.validate()  // ❌ Throws

シリアル化

javascript

// To JSON
const json = JSON.stringify(user)

// From JSON
const user = User.createFrom(json)

// To plain object
const obj = { ...user }

// From plain object
const user2 = new User(obj)

完全な例

Go：

package main

import (
    "time"
    "github.com/wailsapp/wails/v3/pkg/application"
)

type Address struct {
    Street  string `json:"street"`
    City    string `json:"city"`
    Country string `json:"country"`
}

type User struct {
    ID        int       `json:"id"`
    Name      string    `json:"name"`
    Email     string    `json:"email"`
    Address   Address   `json:"address"`
    CreatedAt time.Time `json:"createdAt"`
}

type UserService struct {
    users []User
}

func (s *UserService) GetAll() []User {
    return s.users
}

func (s *UserService) GetByID(id int) (*User, error) {
    for _, user := range s.users {
        if user.ID == id {
            return &user, nil
        }
    }
    return nil, fmt.Errorf("user %d not found", id)
}

func (s *UserService) Create(user User) User {
    user.ID = len(s.users) + 1
    user.CreatedAt = time.Now()
    s.users = append(s.users, user)
    return user
}

func (s *UserService) Update(user User) error {
    for i, u := range s.users {
        if u.ID == user.ID {
            s.users[i] = user
            return nil
        }
    }
    return fmt.Errorf("user %d not found", user.ID)
}

func main() {
    app := application.New(application.Options{
        Services: []application.Service{
            application.NewService(&UserService{}),
        },
    })
    
    app.Window.New()
    app.Run()
}

JavaScript：

javascript

import { GetAll, GetByID, Create, Update } from './bindings/changeme/userservice'
import { User, Address } from './bindings/changeme/models'

class UserManager {
    async loadUsers() {
        const users = await GetAll()
        this.renderUsers(users)
    }
    
    async createUser(name, email, address) {
        const user = new User({
            name,
            email,
            address: new Address(address)
        })
        
        try {
            const created = await Create(user)
            console.log("Created user:", created.id)
            this.loadUsers()
        } catch (error) {
            console.error("Failed to create user:", error)
        }
    }
    
    async updateUser(id, updates) {
        try {
            const user = await GetByID(id)
            Object.assign(user, updates)
            await Update(user)
            this.loadUsers()
        } catch (error) {
            console.error("Failed to update user:", error)
        }
    }
    
    renderUsers(users) {
        const list = document.getElementById('users')
        list.innerHTML = users.map(user => `
            <div class="user">
                <h3>${user.name}</h3>
                <p>${user.email}</p>
                <p>${user.address.city}, ${user.address.country}</p>
                <small>Created: ${user.createdAt.toLocaleDateString()}</small>
            </div>
        `).join('')
    }
}

const manager = new UserManager()
manager.loadUsers()

ベストプラクティス

✅ 推奨事項

JSON タグを使用する — フィールド名を制御できます
コメントを追加する — JSDoc に変換されます
time.Time を使用する — Date に変換されます
Go 側で検証する — フロントエンドを信用しないでください
モデルをシンプルに保つ — データコンテナーとしてのみ使用してください
任意フィールドにはポインターを使用する — null 許容には *string を使用してください

❌ 禁止事項

Go の構造体にメソッドを追加しない — データとして扱ってください
非公開フィールドを使用しない — バインドされません
複雑なインターフェースを使用しない — サポートされていません
JSON タグを付け忘れない — フィールド名は重要です
深くネストしすぎない — シンプルに保ってください

次のステップ

メソッドのバインディング

Go メソッドをバインドする方法を学びます。

詳しく見る →

サービス

サービスを使用してコードを整理します。

詳しく見る →

ベストプラクティス

バインディングの設計パターンを学びます。

詳しく見る →

Go とフロントエンドのブリッジ

ブリッジの仕組みを理解します。

詳しく見る →

ご質問がありますか？ Discord で質問するか、バインディングの例を確認してください。

アクセシビリティ

このドキュメントを編集

データモデル