修改readme
This commit is contained in:
		
							parent
							
								
									fcad15fcf4
								
							
						
					
					
						commit
						72934caa82
					
				@ -3,6 +3,9 @@ using Microsoft.Extensions.Hosting;
 | 
			
		||||
 | 
			
		||||
namespace Falcon.SugarApi.BackTask
 | 
			
		||||
{
 | 
			
		||||
    /// <summary>
 | 
			
		||||
    /// 服务集合方法扩展
 | 
			
		||||
    /// </summary>
 | 
			
		||||
    public static class IServiceCollectionExtend
 | 
			
		||||
    {
 | 
			
		||||
        /// <summary>
 | 
			
		||||
 | 
			
		||||
							
								
								
									
										34
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										34
									
								
								README.md
									
									
									
									
									
								
							@ -1,3 +1,33 @@
 | 
			
		||||
## Falcon.SugarApi    
 | 
			
		||||
### Swagger说明 [进入](/Falcon/Falcon.SugarApi/src/branch/master/Falcon.SugarApi/Swagger)     
 | 
			
		||||
>  `waggerGenOptions.AddXmlEnumEnable`方法可以为枚举类型增加注释。   
 | 
			
		||||
 | 
			
		||||
### WebApi扩展模块  [进入](/Falcon/Falcon.SugarApi/src/branch/master/Falcon.SugarApi/ApiDefinistions)   
 | 
			
		||||
>  `ApiControllerBase`webapi基类,实现数据库、log、异常等基础功能。   
 | 
			
		||||
>  `ApiBaseOptionController<>`带有基本操作方法的webapi基类,除了`ApiControllerBase`功能外还提供基础增删改查功能。   
 | 
			
		||||
 | 
			
		||||
### Swagger扩展模块 [进入](/Falcon/Falcon.SugarApi/src/branch/master/Falcon.SugarApi/Swagger)     
 | 
			
		||||
>  `waggerGenOptions.AddXmlEnumEnable`方法可以为枚举类型增加注释。   
 | 
			
		||||
 | 
			
		||||
### SugarDbContext扩展模块 [进入](/Falcon/Falcon.SugarApi/src/branch/master/Falcon.SugarApi/DatabaseDefinitions)   
 | 
			
		||||
>  `IServiceCollection.AddSugarApiDbContext` 通过注册`SugarDbContext`对象,该对象通过`SugarConnectionConfig`配置数据库链接。   
 | 
			
		||||
>  `DbSet<T>`数据库表定义,支持表数据查询。    
 | 
			
		||||
>  `SugarDbTables<T>`数据库表集合基类,可以继承该类并在其中定义`DbSet<T>`属性,这些会自动实例化。  
 | 
			
		||||
>  `SugarTableBase`标准表基类,继承该类可提供数据表基础功能,比如ID,创建和修改时间等。  
 | 
			
		||||
 | 
			
		||||
### XML序列化扩展模块  [进入](/Falcon/Falcon.SugarApi/src/branch/master/Falcon.SugarApi/XmlSerialize)   
 | 
			
		||||
>  `IServiceCollection.AddXmlSerializeFactory`方法注册xml序列化工厂`XmlSerializeFactory`,可以通过该工厂实例化一个XML序列器。   
 | 
			
		||||
 | 
			
		||||
### JSON序列化扩展模块  [进入](/Falcon/Falcon.SugarApi/src/branch/master/Falcon.SugarApi/JsonSerialize)   
 | 
			
		||||
>  `IServiceCollection.AddJsonSerializeFactory`方法注册Json序列化工厂`JsonSerializeFactory`,可以通过该工厂实例化一个Json序列器。   
 | 
			
		||||
 | 
			
		||||
### 字符串扩展方法    
 | 
			
		||||
>  `IsNullOrEmpty()`和`IsNotNullOrEmpty()`方法返回字符串是否为空。   
 | 
			
		||||
>  `SplitStr()`默认实现按照`',', ',', ';', ';', '.', '。'`对字符串进行分割。  
 | 
			
		||||
 | 
			
		||||
### Object扩展方法   
 | 
			
		||||
>  `CloneTo`和`CloneFrom`实现将对象属性赋值到目标对象同名属性中,此为浅表复制。   
 | 
			
		||||
 | 
			
		||||
### 后台任务BackTask模块  [进入](/Falcon/Falcon.SugarApi/src/branch/master/Falcon.SugarApi/BackTask)   
 | 
			
		||||
>  继承`BackgroundLongTask`可以实现一个长期位于后台执行的对象,该类通过`IServiceCollection.AddHostedService<>'进行注册。
 | 
			
		||||
>  `RunTimespan`属性设置执行的时间间隔的秒数。    
 | 
			
		||||
>  重写`RunAsync`方法实现一个异步任务。   
 | 
			
		||||
>  另外可以重写`OnStart`后台任务开始,`OnStop`后台任务结束,`OnCompleted`一次执行完成和`OnException`执行中引发未处理的异常。  
 | 
			
		||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user