V8 Function List-Backend

Introduction

• server-side V8 engine code and front-end V8 programming language are Javascript syntax
• Server-side V8 engine supports ES6 syntax
• The server-side V8 engine integrates some back-end objects and methods, and can use js to call back-end methods (not http)
• Server-side V8 engine code is executed on the server side
• Server-side V8 functions are mainly used for server-side V8 events, interface engines, data source engines, etc. of form attributes

Interface Engine V8.ApiEngine

• Interface Engine Details
• Server-side V8 events can directly call the interface engine (non-http), and the interface engine can also call the interface engine
• V8 event or interface engine can pass in the event object when calling another interface engine, which can guarantee that the same transaction

//调用方式：
var result = V8.ApiEngine.Run('ApiEngineKey', { 
    Param1 : '1',
});
//同一事务
var resul2 = V8.ApiEngine.Run('ApiEngineKey', { 
    Param2 : '1',
}， V8.DbTrans);

Forms Engine V8.FormEngine

• See platform documentation:FormEngine usage

Cache Operations V8.Cache

• Distributed cache operation class, usage V8.Cache('Key', 'Value', '0.00:10:00 ');

• Note: The format of the expiration time must bed.HH:mm:ss, such0.12:00:000 days, 12 hours,1.10:10:00If the expiration time parameter is not passed for 10 hours and 10 minutes a day, it is permanent.
• The recommended naming rule for the cache key is:Microi:${V8.OsClient}:{分类key值}:{Key}, which is consistent with the platform's cache Key naming rules, is easy to view, and distinguishes SaaS tenants to prevent cache confusion.

var cacheKey = `Microi:${V8.OsClient}:FormData:baoming`;
var cacheValue = JSON.stringify(formData);
//写缓存
var result1 = V8.Cache.Set(cacheKey, cacheValue, '0.00:00:59');//返回bool类型
//获取缓存
var result2 = V8.Cache.Get(cacheKey);//返回string类型，无缓存返回null
//删除缓存。注：若在Set时设置了有效期，到期会自动删除。
var result3 = V8.Cache.Remove(cacheKey);//返回bool类型

• Verification code cache Key naming rules:

`Microi:${OsClient值}:{分类key值}:{Key}`
示例：
`Microi:iTdos:Captcha:aaaa-bbbb-cccc`

• The redis key prefix of the platform always has only 4 levels:

• the first level is used to distinguish which redis folder is used by my code platform when other third-party systems share the same redis instance.
• The second level is used to distinguish saas tenants
• the third level is used to distinguish redis classification, such as verification code
• the fourth level is the key to be used in the end

C# System Class System

• server-side V8 code can directly use the System namespace under. net

//生成一个服务器端GUID值
System.Guid.NewGuid()

//将字符串转为base64字符串，建议使用后封装的V8.Base64
var bytes = System.Text.Encoding.UTF8.GetBytes(originalString);  
var base64String = System.Convert.ToBase64String(bytes);

//解密base64，，建议使用后封装的V8.Base64
var bytes = System.Text.Encoding.UTF8.GetBytes(originalString);  
var base64String = System.Convert.ToBase64String(bytes);

//等待1000毫秒
System.Threading.Thread.Sleep(1000);

//调用服务器端全局V8函数，获取yyyy-MM-dd HH:mm:ss格式的当前时间字符串。若获取日期格式，可使用new Date();
V8.Action.GetDateTimeNow()

//如果在服务器端全局V8函数是通过function DateNow(){}这样定义的，则可以直接使用DateNow()
var nowDate = DateNow('yyyy_mm-dd HH:mm:ss');

//异步执行V8代码，方法1（推荐）
var timer1 = setTimeout(function() {
    V8.FormEngine.UptFormData('diy_test1', {
      Id : '8007f94b-4883-4a0c-8c23-f25aca910722'
      Text45 : '2222',
    });
}, 1000);
//可在timer1开始执行前随时手动提前终止定时执行
clearTimeout(timer1);

//异步执行V8代码，方法2
System.Threading.Tasks.Task.Run(function(){
  //实现setTimeout(function, 1000)的效果，不加则是setTimeout(function, 0)的异步效果
  System.Threading.Thread.Sleep(1000);
  V8.FormEngine.UptFormData('diy_test1', {
    Id : '8007f94b-4883-4a0c-8c23-f25aca910722'
    Text45 : '2222',
  });
});

Common functions V8.Method

• Integrates some common functions, can be customized extension

//从redis中获取当前登陆用户的token和身份信息
//token：可选，是否包含Bearer均支持
//osClient：可选
var currentTokenObj = V8.Method.GetCurrentToken(token, osClient)
//返回：{ OsClient : '', CurrentUser : {}, Token : '不包含 Bearer ' } 或 null

//刷新用户的登陆身份redis缓存信息，必传userId、osClient
V8.Method.RefreshLoginUser(userId, osClient)

//获取私有文件的临时访问地址，可传入FilePathName、或FilePathNames
V8.Method.GetPrivateFileUrl()
var result = V8.Method.GetPrivateFileUrl({
    FilePathName : '/microi/file/2023-08-06/xxx.doc',
    //FilePathNameS : ['/microi/file/2023-08-06/xxx.doc']
});
//返回{ Code : 1/0, Data : '临时访问地址'/['临时访问地址'], Msg : '错误信息' }

//添加系统日志
V8.Method.AddSysLog({
	Type : '', //日志类型，自定义文字，如：接口日志、性能日志、登录日志等
	Title : '', //日志标题，如：张三登录了系统
	Content: '', //日志内容，如：张三在2024-12-12 20:13通过扫码登录了系统 
	OtherInfo : '', //其它信息，如：{ Append : 'test' }
	Remark : '', //日志备注
	Level : 1,//日志等级
});

V8.Base64

• Base64 conversion. Unlike System.Convert.ToBase64String(bytes), V8.Base64 directly returns the source string if an exception occurs.

var result = V8.Base64.StringToBase64('123456');
var result = V8.Base64.Base64ToString('MTIzNDU2');

Current User V8.CurrentUser

• The information of the current login user, including the role and organization of the user, and the information of the fields added to the sys_user table by using the form engine.
• The value accessed when not logged in is {}

var userName = V8.CurrentUser.Name;

Database Objects V8.Db

• Database access object, support Dos.ORM, SqlSugar switching

//用例：
var list = V8.Db.FromSql("select * from table")//也可以使用V8.DbTrans.FromSql()
                .ToArray(); //返回数组数据，一般用于select查询多条数据语句
                //返回受影响行数，一般用于update、delete、insert语句
                .ExecuteNonQuery(); 
                //返回单条数据，一般用于select查询单条数据语句
                .First(); 
                //返回单条数据的单个字段值，一般用于select单条数据查询、聚合函数、单个字段，如：select sum(Money) from table、select Name from table
                .ToScalar();

Database read-only objects V8.DbRead

• Database read-only object. The usage is the same as that of V8.Db. When read/write splitting is not deployed in the database, the value of this object is consistent with that of the V8.Db object.

Extended Database Objects V8.Dbs.DbKey

• access to multi-database (extended library) objects, extended library management see:https://web.microi.net/#/database
• note: the [DbKey] field is missing in the table above the old database version. you need to update the database, add it manually, or wait for the application store to go online and install the [database management] application.
• Example: When accessing the Oracle extension library, the value of DbKey is OracleDB1, where the V8.Dbs.OracleDB1 object is equivalent to the V8.Db object.

var dataList = V8.Dbs.OracleDB1.FromSql('').ToArray();

//扩展数据库的事务用法
var emptyExTrans = V8.Dbs.EmptyEx.BeginTransaction();
var count = emptyExTrans.FromSql("delete from diy_extend_test where Id='49ec484d-a2cf-47fe-b498-6efb2bf9f99d'").ExecuteNonQuery();
//emptyExTrans.Commit();//提交事务
emptyExTrans.Rollback();//回滚事务
emptyExTrans.Close();//释放事务对象
return { Code : 1, Data : count };

• known problem: after adding the extension library to the platform, the docker container of the api needs to be restarted before it takes effect.

Database Transactions V8.DbTrans

• Database transaction objects, which can be used like V8.Db, such:

var array = V8.DbTrans.FromSql('...').ToArray();

• There is no need to use try catch in the interface engine to catch the exception and execute [V8.DbTrans.Rollback()]. The interface engine will recognize the exception and execute [V8.DbTrans.Rollback()]]
• Interface Engine Example

//操作第一张表，带事务
var result1 = V8.FormEngine.UptFormData('表名或表Id，不区分大小写', {
    Id : '',//必传
    Age : 20, //要修改的字段，注意字段值不能是{}或[]，需要序列化
    Sex : '女'
}， V8.DbTrans);
//操作第二张表，带事务
var result2 = V8.FormEngine.UptFormData('表名或表Id，不区分大小写', {
    Id : '',//必传
    Age : 20, //要修改的字段，注意字段值不能是{}或[]，需要序列化
    Sex : '女'
}， V8.DbTrans);
//如果第二张表操作成功
if(result2.Code == 1){
  return { Code : 1 };//平台会自动提交事务，因为返回的Code=1
}else{//如果第二张表操作失败
  return { Code : 0, Msg : result.Msg };//平台会自动回滚事务，因为返回的Code=0
}

V8.MongoDb

Introduction

• This article describes how to perform related operations on MongoDB in the interface engine and backend V8 events
• the new operation on the MongoDB will automatically generate the corresponding database name and table name, so you can customize the rules for dividing the database and table.

Add Data AddFormData

• custom database name, table name, automatically created if it does not exist

//可以指定固定的Id值
var newId = V8.MongoDb.NewId();
V8.MongoDb.AddFormData({
	DbName : '', //数据库名称，如：sys_log_2024
	TableName: '', //表名名称，如：log_2024_12
	Id : newId, //也可以不指定，会自动生成
	_FormData : {
		Name : '张三',
		Sex : '男',
		Age : 18
	}
});

Modify Data DelFormData

V8.MongoDb.UptFormData({
	DbName : '', //数据库名称，如：sys_log_2024
	TableName: '', //表名名称，如：log_2024_12
	Id : '', //数据Id
	_FormData : {
		Name : '张三',
		Sex : '男',
		Age : 18
	}
});

Delete Data DelFormData

V8.MongoDb.DelFormData({
	DbName : '', //数据库名称，如：sys_log_2024
	TableName: '', //表名名称，如：log_2024_12
	Id : '', //数据Id
});

Query data list GetTableData

V8.MongoDb.GetTableData({
	DbName : '', //数据库名称，如：sys_log_itdos
	TableName: '', //表名名称，如：log_202412
  _Where : [
    ['Type', '=', '访问菜单'], 
    ['OR', 'Type', '=', '点击V8按钮']
  ]
});

query a single data GetFormData

V8.MongoDb.GetFormData({
	DbName : '', //数据库名称，如：sys_log_2024
	TableName: '', //表名名称，如：log_2024_12
	Id : '', //数据Id
});

V8.Http

• for RestSharp encapsulation, note that the post of the front end V8 is V8.Post(). at present, V8.Http is not encapsulated for the time being. the writing method is inconsistent for the time being and will be unified later.

//post请求，返回string，对应的也有V8.Http.Get，参数名称则为GetParam
var loginResult = V8.Http.Post({
  Url : 'http://192.168.0.173:1052/api/SysUser/login', //必传
  PostParam : { Account : 'admin', Pwd : '****', OsClient : 'veken' },
  //注意目前PostParam暂不支持多级属性，如：{ User: { Account : 'admin' }, OsClient : 'veken' }，此时则需要传入序列化后的字符串，如：
  PostParamString : JSON.stringify({ User: { Account : 'admin' }, OsClient : 'veken' }),
  ParamType : 'json', //请求类型，默认form
  Timeout : 5, //请求超时时间，单位秒，默认5秒
  Headers : { token : '', did : ''  }, //请求报文，参数名也可以是Header，平台均支持
  FilesByteBase64 : {}, //上传文件，后期补充用法
  FilesByteString : {}, //上传文件，后期补充用法
});

//post请求，返回Response对象，目前里面暂时只包含Headers、Content。，对应的也有V8.Http.GetResponse，参数数名称则为GetParam
var loginResult2 = V8.Http.PostResponse({
  Url : 'http://192.168.0.173:1052/api/SysUser/login',
  PostParam : { Account : 'admin', Pwd : '******', OsClient : 'veken' }
});
//获取header中的Authorization值
var header = loginResult2.Headers.find(item => {
  return item.Name == 'Authorization' || item.Name == 'authorization';
})
if(header){
  //再获取当前登陆身份信息，测试传入header
  var token = header.Value;
  var getCurrentUser = V8.Http.Post({
    Url: 'http://192.168.0.173:1052/api/SysUser/getCurrentUser',
    Headers: { authorization : 'Bearer ' + token}
  });
  return {
    Code : 0, Msg : '获取身份信息成功：' + getCurrentUser
  };
}else{
  //未获取到token
  return {
    Code : 0,  Msg : '获取header失败：' + loginResult2
  }
}

//发起xml请求
var result = V8.Http.Post({
  Url : 'http://192.168.0.173:1052/api/SysUser/login',
  ParamType : 'xml',
  PostParamString : '<xml><text>1</text></xml>'
});

V8.Header, V8.Param

• currently, both of them can only be used in the interface engine to obtain the message sent by the client http post request interface engine address and Request Payload parameters.

Encryption class V8.EncryptHelper

• Dos.Common Encryption Help Class

var pwd = V8.EncryptHelper.DESEncode('123456');//DES加密
var pwd = V8.EncryptHelper.DESDecode('JdZe5gWKjZo=');//DES解密
var pwd = V8.EncryptHelper.SHA1('123456');
var pwd = V8.EncryptHelper.SHA256('123456');
var pwd = V8.EncryptHelper.SHA512('123456');
var pwd = V8.EncryptHelper.MD5Encrypt('123456');//MD5加密
var pwd = V8.EncryptHelper.Sha256Hex('123456');

V8.Office

Send Mail SendEmail

• Source implementation in /Microi.Server/Microi.Office/MicroiOffice.cs

return V8.Office.SendEmail({
  SmtpServer : 'smtp.qq.com',
  SmtpPort : 587,
  EnableSSL : true,
  SystemEmail : 'admin@itdos.com',
  SystemEmailPwd : 'uuzrnazvv*******',
  EmailSubject : '测试接口引擎发邮件标题',
  EmailBody : '<b>测试接口引擎发邮件内容，<span style="color:red;">支持html</span></b>',
  Receivers : ['123446172@qq.com', '973702@qq.com']
});

System Settings V8.SysConfig

• Access to system settings information, you can access to system settingssys_configAny field of the table

var sysTitle = V8.SysConfig.SysTitle;

SaaS Engine Information V8.OsClientModel

• Access sensitive configuration data of the current SaaS engine
• sensitive configurations of third-party systems should also be put into the configuration of SaaS engine, such as key and secret of third-party systems.

//获取redis host
var redisHost = V8.OsClientModel.RedisHost;

Form Data V8.Form

• The form data can be accessed in the form submission event, and this object is empty in the interface engine.

V8.OldForm

• When modifying data, the backend V8 event can access the data value before V8.OldForm modification

V8.FormSubmitAction

• Form submission type: Possible values:Insert Delete Update(string type)

• Note that there is no server-side V8 eventFormOutAction,FormOutAfterAction, onlyFormSubmitAction

V8.EventName

• The name of the backend V8 event. It is relatively easy to use in the global V8 engine code. Possible values:

FormSubmitBefore：表单提交前V8事件
FormSubmitAfter：表单提交后V8事件
DataFilter：数据处理V8事件
WFNodeLine：流程节点条件判断V8事件
WFNodeEnd：流程节点结束V8事件
WFNodeStart：流程节点开始V8事件

V8.Param

• Used to access the parameters passed in by the front end, url parameters, form-data parameters, and payload-json parameters can be accessed.

V8.Action

• Used to access methods customized at the global server V8 code

V8.InvokeType

• Access to the current call type, possible values:Server,ClientWhen the accessed V8.InvokeType is empty, the defaultServer *Server: Server-side calls, such as calling the interface engine in the interface engine and calling the interface engine in the back-end V8 event *Client: Front-end calls, such as calling the interface engine in the front-end V8 event and submitting the form in the front-end

V8.TableModel

• In the backend V8 event, you can access the current operationdiy_tableTable Information

V8.OsClient

• Access the current OsClient value

console

• Microi.net.dll supports console to output logs to the server since v3.5.1

console.log('日志输出');
console.error('日志输出');
console.warn('日志输出');
console.info('日志输出');
//服务端查看日志
docker logs microi-api