V.User 1.0.0

.NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package V.User --version 1.0.0                

                    
                

            
NuGet\Install-Package V.User -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="V.User" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add V.User --version 1.0.0                

                    
                

            
#r "nuget: V.User, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install V.User as a Cake Addin
#addin nuget:?package=V.User&version=1.0.0

// Install V.User as a Cake Tool
#tool nuget:?package=V.User&version=1.0.0

V.User

木叉一人工作室封装的用户模块，包括手机号、邮箱登录以及 OAuth 授权登录等

Nuget

V.User

官方示例项目

V.TouristGuide

如何使用

public void ConfigureServices(IServiceCollection services)
{
    services.AddJwt("JwtSecret")
        .AddUserModule(new UserModuleCallback(builder.Configuration), c =>
        {
            c.ServiceCode = "自定义服务唯一编码";
            c.ServiceName = "自定义服务名称";
            c.NeedVerificationForSignUp = true; // 注册时是否需要验证，否则使用密码直接注册
            c.AccountMode = 1; // 账户主体 0 Mail 1 Mobile
            c.TencentSmsSecretId = "腾讯云短信服务 SecretId";
            c.TencentSmsSecretKey = "腾讯云短信服务 SecretKey";
            c.TencentSmsAppId = "腾讯云短信服务 AppId";
            c.TencentSmsSignName = "腾讯云短信已审核过的签名";
            c.TencentSmsTemplateId = "腾讯云短信已审核过的模板id";
        });
}

public void Configure(IApplicationBuilder app)
{
    app.UseUserModule(true);
}

public class UserModuleCallback : IUserModuleCallback
{
    private IConfiguration config;

    public UserModuleCallback(IConfiguration config)
    {
        this.config = config;
    }

    public Task OnOAuthLogin(HttpContext context, UserModel user)
    {
        context.Response.Redirect($"{this.config["OAuthCallbackUrl"]}?token={user.Token}");
        return Task.CompletedTask;
    }
}

AddUserModule 方法有两个参数，第一个参数为 Action<Configuration> 用于修改用户模块配置；第二个参数为 IUserModuleCallback 接口，该参数用于接收 OAuth 授权登录回调，若该参数为空则不启用 OAuth

UseUserModule 方法有一个可选参数 useOAuth 表示是否启用 OAuth，若调用 AddUserModule 方法时没有传第二个参数，则这里的 useOAuth 应为 false，否则服务启动时会报依赖的服务不存在

接口

POST /usermodule/signup

注册账号，若 NeedVerificationForSignUp 为 true，则会发送验证邮件或短信

Request：
{
    "mail": "", // 若账户主体为邮箱则必传
    "mobile": "", // 若账户主体为手机号则必传
    "password": "" // 若 NeedVerificationForSignUp 为 false，则密码必传
}
Response：
{
    "code": 0, // 0 成功 -1 失败
    "msg": "", // 失败原因
    "data": "contextId", // 在使用验证码注册的场景下会返回上下文 id，用于后续接口调用
    "data": { // 若使用密码注册成功时直接返回用户信息
        "id": 6,
        "name": "Venyo Wong",
        "avatar": "https://avatars.githubusercontent.com/u/5902200?v=4",
        "gender": 0,
        "source": "github",
        "sourceName": null,
        "platformId": "5902200",
        "mail": "venyowong@163.com",
        "location": "Shanghai",
        "company": "",
        "bio": "Hou tui, wo yao kai shi zhuang bi le.",
        "maskMobile": null,
        "md5Mobile": null,
        "encryptedMobile": null,
        "createTime": "2022-09-24T05:20:04.044308Z",
        "updateTime": "2022-10-04T07:30:12.864247Z",
        "token": null,
        "canSetPwd": false // 是否可以设置密码
    }
}

POST /usermodule/login

登录接口

Request：
{
    "mail": "", // 若账户主体为邮箱则必传
    "mobile": "", // 若账户主体为手机号则必传
    "password": "" // 若密码为空，则使用验证码登录
}
Response：
{
    "code": 0, // 0 成功 -1 失败
    "msg": "", // 失败原因
    "data": "contextId", // 在使用验证码登录的场景下会返回上下文 id，用于后续接口调用
    "data": { // 若使用密码登录成功时直接返回用户信息
        "id": 6,
        "name": "Venyo Wong",
        "avatar": "https://avatars.githubusercontent.com/u/5902200?v=4",
        "gender": 0,
        "source": "github",
        "sourceName": null,
        "platformId": "5902200",
        "mail": "venyowong@163.com",
        "location": "Shanghai",
        "company": "",
        "bio": "Hou tui, wo yao kai shi zhuang bi le.",
        "maskMobile": null,
        "md5Mobile": null,
        "encryptedMobile": null,
        "createTime": "2022-09-24T05:20:04.044308Z",
        "updateTime": "2022-10-04T07:30:12.864247Z",
        "token": null,
        "canSetPwd": false // 是否可以设置密码
    }
}

POST /usermodule/setpassword

设置密码接口，仅支持在用户密码为空时，例如使用验证码注册或 OAuth 登录

Request：
{
    "token": "", // 登录或注册后获取到的 token，该参数可放在 queryString、form、headers、body 中
    "password": ""
}
Response：
{
    "code": 0, // 0 成功 -1 失败
    "msg": "" // 失败原因
}

POST /usermodule/resetpassword

使用旧密码重置密码接口

Request：
{
    "token": "", // 登录或注册后获取到的 token，该参数可放在 queryString、form、headers、body 中
    "oldPwd": "",
    "newPwd": ""
}
Response：
{
    "code": 0, // 0 成功 -1 失败
    "msg": "" // 失败原因
}

POST /usermodule/forgetpassword

忘记密码时，使用验证码重置密码接口

Request：
{
    "mail": "", // 若账户主体为邮箱则必传
    "mobile": "" // 若账户主体为手机号则必传
}
Response：
{
    "code": 0, // 0 成功 -1 失败
    "msg": "", // 失败原因
    "data": "contextId" // 上下文 id，用于后续接口调用
}

POST /usermodule/verifycode

验证码校验接口，所有验证码场景都可以调用该接口进行校验

Request：
{
    "contextId": "", // 上下文 id
    "code": "" // 验证码
}
Response：
{
    "code": 0, // 0 成功 -1 失败
    "msg": "", // 失败原因
    "data": { // 仅在注册成功、重置密码成功、登录成功的场景下会返回该字段
        "id": 6,
        "name": "Venyo Wong",
        "avatar": "https://avatars.githubusercontent.com/u/5902200?v=4",
        "gender": 0,
        "source": "github",
        "sourceName": null,
        "platformId": "5902200",
        "mail": "venyowong@163.com",
        "location": "Shanghai",
        "company": "",
        "bio": "Hou tui, wo yao kai shi zhuang bi le.",
        "maskMobile": null,
        "md5Mobile": null,
        "encryptedMobile": null,
        "createTime": "2022-09-24T05:20:04.044308Z",
        "updateTime": "2022-10-04T07:30:12.864247Z",
        "token": null,
        "canSetPwd": false // 是否可以设置密码
    }
}

POST /usermodule/updateinfo

更新用户信息接口

Request：
{
    "token": "", // 登录或注册后获取到的 token，该参数可放在 queryString、form、headers、body 中
    "name": "", // 昵称
    "avatar": "", // 头像
    "mail": "", // 邮箱，在用户主体为邮箱时，该参数不为空时，将作为更换邮箱操作，其他字段不起作用
    "location": "", // 地址
    "company": "", // 公司
    "bio": "", // 简介
    "mobile": "" // 手机号，在用户主体为手机号时，该参数不为空时，将作为更换手机号操作，其他字段不起作用
}
Response：
{
    "code": 0, // 0 成功 -1 失败
    "msg": "", // 失败原因
    "data": "contextId" // 仅在更换邮箱、手机号时会返回该字段
}

/usermodule/info

获取用户信息

Request：
{
    "token": "" // 登录或注册后获取到的 token，该参数可放在 queryString、form、headers、body 中
}
Response：
{
    "id": 6,
    "name": "Venyo Wong",
    "avatar": "https://avatars.githubusercontent.com/u/5902200?v=4",
    "gender": 0,
    "source": "github",
    "sourceName": null,
    "platformId": "5902200",
    "mail": "venyowong@163.com",
    "location": "Shanghai",
    "company": "",
    "bio": "Hou tui, wo yao kai shi zhuang bi le.",
    "maskMobile": null,
    "md5Mobile": null,
    "encryptedMobile": null,
    "createTime": "2022-09-24T05:20:04.044308Z",
    "updateTime": "2022-10-04T07:30:12.864247Z",
    "canSetPwd": false // 是否可以设置密码
}

启用 OAuth

调用 AddUserModule 方法时传入 IUserModuleCallback 参数，并且在调用 UseUserModule 方法时传入 true，即可启用 OAuth，具体配置方法可参考 V.User.OAuth 项目

注

该用户模块目前只有账号主体为手机号的场景详细测试过，若使用过程中遇到问题，请提交 issue 或 PR

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.0 99 7/12/2024
1.0.5 164 12/6/2023
1.0.4 161 5/29/2023
1.0.3 317 11/26/2022
1.0.2 317 11/18/2022
1.0.1 388 10/5/2022
1.0.0 395 10/4/2022