DH.NCode 3.91.2024.924-beta0715

DH.NCode - 数据中间件

数据中间件，聚焦于添删改查、性能和大数据，支持MySQL、SQLite、SqlServer、Oracle、Postgresql、TDengine、达梦、金仓、瀚高。

数据中间件

功能特点：

化繁为简

建立XML数据模型后，经代码生成得到实体类，即可使用实体类对数据进行添删改查操作。

开发环境默认使用SQLite数据库，发布到生产环境时再配置连接字符串即可。

日常项目中90%的功能开发无需掌握数据库和SQL，降低对开发者的能力要求，特别是Java等其它语言转过来的开发者。

多数据库迁移

支持MySQL、SQLite、SqlServer、Oracle、Postgresql等各种主流数据库，基于XCode开发的应用无需修改编译即可迁移到另一种数据库上。甚至开发数据库和生产数据库是两种不同的数据库，例如常见SQLite开发，生产用MySql。

高性能

极致的多级缓存设计，批量操作优化，单机插入速度最高89万tps，查询速度最高18亿qps。飞仙

单表查询配合内存关联（带数据缓存），降低系统复杂度并提升性能。

大数据

正式项目最大单表100亿数据，分页查询的思想贯穿上下。

根据模型表的索引自动生成各种高效的查询方法，让开发者无惧大数据表。

自动分表分库

支持任意数据库按策略自动分表分库，无需修改业务代码，XCode能够自动找到正确的表。

例如星尘跟踪数据按天分表，配置分表策略后，其它添删改查操作跟单表一样：

Meta.ShardPolicy = new TimeShardPolicy(nameof(Id), Meta.Factory)
{
    ConnPolicy = "{0}",
    TablePolicy = "{0}_{1:yyyyMMdd}",
    Step = TimeSpan.FromDays(1),
};

反向工程

根据实体类主动建立数据库表结构并初始化数据（支持所有数据库），开发阶段新增字段，在发布到生产后自动新增，开发者无需准备SQL发布脚本。

跨库数据迁移

支持任意数据库进行数据迁移。跨库数据迁移工具

快速入门

新建项目

打开Visual Studio，新建一个控制台项目，从Nuget引入NewLife.XCode。

新建模型

在项目目录下编写一个简单Xml模型文件db.xml，或者下载xcodetool.exe保存到项目目录，运行xcodetool.exe即可得到一个样本模型文件。

<?xml version="1.0" encoding="utf-8"?>
<Tables Version="9.6.6644.19804" Output="MyEntity" NameSpace="Model" BaseClass="Entity" ConnName="DB">
  <Table Name="UserInfo" Description="用户信息">
    <Columns>
      <Column Name="Id" DataType="Int32" Identity="True" PrimaryKey="True" Description="会员id" />
      <Column Name="UserName" DataType="String" Nullable="False" Description="会员名称" />
      <Column Name="Password" DataType="String" Nullable="False" Description="会员密码" />
      <Column Name="Age" DataType="Int32" Description="会员年龄" />
    </Columns>
  </Table>
</Tables>

双击xml文件旁边的xcodetool.exe，这时你会看到生成一个MyEntity文件目录，目录包含了两个文件：用户信息.Biz.cs、用户信息.cs。 “用户信息.cs” 一般称为数据类，每次代码生成都会覆盖，“用户信息.Biz.cs”称为业务类，首次生成后不再覆盖，适合用户在其中写代码。

如果不用xcodetool.exe，也可以从Nuget安装全局工具：dotnet tool install xcodetool -g --prerelease。

然后在项目目录下执行命令：xcode db.xml

增删改查

• Program.cs文件最上面引用命名空间

using XCode;

不然会使用不了Save、Update、Delete等扩展方法。

• 新增一条数据。注：这里没有指定数据库，所以XCode默认的是sqlite数据库。代码完成后可以直接运行看效果。

var user = new UserInfo();
user.UserName = "张三";
user.Password = "123456";
user.Age = 18;
user.Insert();
//user.Save()等效

Console.WriteLine("插入一条新数据，用户id为：" + user.Id);

• 修改一条数据

var user = UserInfo.FindById(1);
user.UserName = "张三";
user.Password = "123456";
user.Age = 19;
user.Update();
//user.Save()等效

user = UserInfo.FindById(1);
Console.WriteLine($"用户ID={user.Id}已修改岁数，岁数为：{user.Age}");

• 删除一条数据

var user = UserInfo.FindById(1);
user.Delete();

user = UserInfo.FindById(1);
Console.WriteLine("用户" + (user == null ? "已删除" : "还存在"));

• 查询数据，查询是一个十分复杂的需求，这里只举一些简单的例子

// 根据Id查询用户信息
var userId = 2;
var user = UserInfo.FindById(userId);
Console.WriteLine($"ID为{user.Id}用户姓名为：{user.UserName}");

// 根据用户名称查询
var userList = UserInfo.FindAll(UserInfo._.UserName == "张三");
Console.WriteLine($"查询符合姓名为张三的记录有{userList.Count}");

// 多复合条件查询
userList = UserInfo.FindAll(UserInfo._.UserName == "张三" & UserInfo._.Age == 19);
Console.WriteLine($"查询符合姓名为张三年龄为19的记录有{userList.Count}");

高级用法

更新某些字段。在“用户信息.Biz.cs”中新增方法写以下代码会更简洁，内置_类无需类名前缀。

UserInfo.Update(UserInfo._.UserName == "李四" & UserInfo._.Age == 18, UserInfo._.Id == 1);
// 相当于Update UserInfo Set UserName='李四' And Age=18 Where Id=1
// 绕过了缓存，不推荐这种写法。建议先查出来对象，然后修改并Update回去

复杂的查询语句

var userList = UserInfo.FindAll(UserInfo._.UserName == "张三" & UserInfo._.Age == 19, UserInfo._.UserName.Desc(), string.Join(",", UserInfo._.UserName, UserInfo._.Age), 0, 0);
// 相当于Select UserName,Age From UserInfo Where UserName='张三' And Age=19 Order By  UserName desc

带分页排序的复杂查询
一般写在实体类业务文件（.Biz.cs）里面，可以直接使用实体类内置_类而无需加类名前缀。

public static IList<UserInfo> Search(String name, Int32 age, Pager p)
{
    // 多条件复杂查询
    var exp = new WhereExpression();
    if(!name.IsNullOrEmpty()) exp &= _.UserName == name;
    if(age > 0) exp &= _.Age == age;

    return FindAll(exp, p);
}

void Test()
{
    // 默认第一页，每页20行。魔方NewLife.Cube自动从页面Request获取以下参数
    var p = new Pager();
    p.PageIndex = 3;
    p.PageSize = 10;
    p.Sort = UserInfo.__.Age;
    p.Desc = true;

    // 需要总记录数来分页，FindAll后p.TotalCount有总记录数，用于计算页数PageCount
    p.RetrieveTotalCount = true;

    // 相当于Select * From UserInfo Where UserName='张三' And Age=19 Order By Age Desc limit 20, 10
    var list = UserInfo.Search("张三", 19, p);
}

复合排序的分页查询语句

var pageIndex = 2;//第二页
var pageSize = 10;//每页十行

var userList = UserInfo.FindAll(UserInfo._.UserName == "张三" & UserInfo._.Age == 19, " UserName desc,Age asc", string.Join(",", UserInfo._.UserName, UserInfo._.Age), (pageIndex - 1) * pageSize, pageSize);
//相当于Select UserName,Age From UserInfo Where UserName='张三' And Age=19 Order By UserName desc,Age asc limit 10, 10

索引查询

修改XML模型文件，增加索引。

  <Tables>
    <Table Name="UserInfo" Description="用户信息">
      <Columns>
        <Column Name="Id" DataType="Int32" Identity="True" PrimaryKey="True" Description="会员id" />
        <Column Name="UserName" DataType="String" Nullable="False" Description="会员名称" />
        <Column Name="Password" DataType="String" Nullable="False" Description="会员密码" />
        <Column Name="Age" DataType="Int32" Description="会员年龄" />
      </Columns>
      <Indexes>
        <Index Columns="UserName" Unique="True" />
        <Index Columns="UserName,Age" />
      </Indexes>
    </Table>
  </Tables>

再次运行xcodetool.exe，即可看到，“用户信息.cs”增加了FindByUserName方法。此处不建议认为修改，下次代码生成会覆盖。

    /// <summary>根据会员名称查找</summary>
    /// <param name="userName">会员名称</param>
    /// <returns>实体对象</returns>
    public static UserInfo FindByUserName(String userName)
    {
        if (userName.IsNullOrEmpty()) return null;

        // 实体缓存
        if (Meta.Session.Count < 1000) return Meta.Cache.Find(e => e.UserName.EqualIgnoreCase(userName));

        return Find(_.UserName == userName);
    }

“用户信息.Biz.cs”中增加了Search方法。在Biz业务类中，这个代码可以根据需要修改调整，代码生成器不会覆盖。

    /// <summary>高级查询</summary>
    /// <param name="userName">会员名称</param>
    /// <param name="age">会员年龄</param>
    /// <param name="key">关键字</param>
    /// <param name="page">分页参数信息。可携带统计和数据权限扩展查询等信息</param>
    /// <returns>实体列表</returns>
    public static IList<UserInfo> Search(String userName, Int32 age, String key, PageParameter page)
    {
        var exp = new WhereExpression();

        if (!userName.IsNullOrEmpty()) exp &= _.UserName == userName;
        if (age >= 0) exp &= _.Age == age;
        if (!key.IsNullOrEmpty()) exp &= _.UserName.Contains(key) | _.Password.Contains(key);

        return FindAll(exp, page);
    }

容器化部署

XCode 支持从环境变量中获取数据库连接字符串，用于容器化部署。
连接字符串的环境变量命名规范为 XCode_{ConnName}，不区分大小写，连接字符串中需要使用provider指定数据库类型。