Nuxt3 的生命周期和钩子函数（八）

// plugins/prepare-types.js

export default defineNuxtPlugin((nuxtApp) => {
  // 使用 prepare:types 钩子
  nuxtApp.hook('prepare:types', (options) => {
    // 修改 tsconfig.json 中的选项
    options.tsConfig.compilerOptions.lib.push('DOM');

    // 在 nuxt.d.ts 中添加自定义类型声明
    options.nuxtTypes.push(`type CustomType = { key: string; value: number; };`);
    options.nuxtTypes.push(`interface CustomInterface { customMethod(): void; }`);

    // 如果需要引入自定义的类型定义文件，可以这样做
    // options.nuxtTypes.push(`/// <reference path="path/to/your/declarations.d.ts" />`);

    // 注意：这里只是示例代码，实际使用时需要根据实际情况来修改
  });
});

// plugins/listen.js

export default defineNuxtPlugin((nuxtApp) => {
  // 使用 listen 钩子
  nuxtApp.hook('listen', (listenerServer, listener) => {
    // 注册自定义事件监听器
    listenerServer.on('request', (req, res) => {
      // 自定义请求处理逻辑
      console.log('Received request:', req.url);
      // 注意：这里不要结束响应，否则会干扰正常的请求处理
    });

    // 注册自定义错误监听器
    listenerServer.on('error', (error) => {
      // 自定义错误处理逻辑
      console.error('Server error:', error);
    });

    // 如果需要在服务器启动后执行某些操作，可以在这里监听 'listening' 事件
    listenerServer.on('listening', () => {
      console.log('Server is listening on port:', listenerServer.address().port);
    });

    // 注意：这里只是示例代码，实际使用时需要根据实际情况来修改
  });
});

// plugins/schemaExtend.js

export default defineNuxtPlugin((nuxtApp) => {
  // 使用 schema:extend 钩子
  nuxtApp.hook('schema:extend', (schemas) => {
    // 向模式中添加新字段
    schemas.user.add({
      age: {
        type: Number,
        required: true
      }
    });

    // 修改现有字段的属性
    schemas.user.fields.name.type = String;

    // 定义新的关系
    schemas.user.relations = {
      posts: {
        type: 'hasMany',
        model: 'Post'
      }
    };

    // 注意：这里只是示例代码，实际使用时需要根据实际情况来修改
  });
});

// plugins/schemaResolved.js

export default defineNuxtPlugin((nuxtApp) => {
  // 使用 schema:resolved 钩子
  nuxtApp.hook('schema:resolved', (schema) => {
    // 检查已解析的模式
    console.log('已解析的模式:', schema);

    // 假设我们需要对用户模式中的某个字段做额外处理
    if (schema.has('user')) {
      const userSchema = schema.get('user');

      // 检查是否存在特定的字段
      if (userSchema.has('email')) {
        // 对 email 字段做额外处理
        userSchema.extend({
          emailVerified: {
            type: Boolean,
            default: false
          }
        });
      }
    }

    // 注意：这里只是示例代码，实际使用时需要根据实际情况来修改
  });
});

// plugins/schemaBeforeWrite.js

export default defineNuxtPlugin((nuxtApp) => {
  // 使用 schema:beforeWrite 钩子
  nuxtApp.hook('schema:beforeWrite', (schema) => {
    // 在这里可以对即将写入的模式进行检查或修改
    console.log('即将写入的模式:', schema);

    // 假设我们需要在写入前确保所有的用户都有一个角色
    if (schema.has('user')) {
      const userSchema = schema.get('user');

      // 确保 'role' 字段存在
      if (!userSchema.has('role')) {
        // 如果不存在，则添加 'role' 字段
        userSchema.extend({
          role: {
            type: String,
            default: 'user' // 默认角色为 'user'
          }
        });
      }
    }

    // 注意：这里只是示例代码，实际使用时需要根据实际情况来修改
  });
});

// plugins/schemaWritten.js

export default defineNuxtPlugin((nuxtApp) => {
  // 使用 schema:written 钩子
  nuxtApp.hook('schema:written', () => {
    // 在这里可以对已写入的模式进行后续操作
    console.log('模式已成功写入');

    // 假设我们需要在模式写入后发送一个通知
    // 这里可以调用一个通知服务或记录日志
    sendNotification('模式已成功写入');

    // 注意：这里只是示例代码，实际使用时需要根据实际情况来修改
  });
});