mirror of https://github.com/abpframework/abp.git
maliming
6 years ago
489 changed files with 532922 additions and 15538 deletions
@ -0,0 +1,97 @@ |
|||
# Send Real-time Notifications via SignalR in ABP Project |
|||
|
|||
SignalR is an open source library that adds real-time operation functionality to applications. Real-time web functionality enables server-side code to instantly send content to clients without refreshing the page. I'll show you how to add SignalR and use it to send notifications from backend. I'll implement this functionality in MVC template of ABP Framework. |
|||
 |
|||
|
|||
## Implement Backend |
|||
|
|||
### Create Notification Hub |
|||
|
|||
Create a new folder named `SignalR` in your root directory of your Web project. |
|||
|
|||
 |
|||
|
|||
Then add the following classes to the folder: |
|||
|
|||
1. [INotificationClient.cs](https://gist.github.com/ebicoglu/f7dc22cca2d353f8bf7f68a03e3395b8#file-inotificationclient-cs) |
|||
2. [UiNotificationClient.cs](https://gist.github.com/ebicoglu/f7dc22cca2d353f8bf7f68a03e3395b8#file-uinotificationclient-cs) |
|||
3. [UiNotificationHub.cs](https://gist.github.com/ebicoglu/f7dc22cca2d353f8bf7f68a03e3395b8#file-uinotificationhub-cs) |
|||
|
|||
### Configure Module |
|||
|
|||
These 3 steps will be done in your web module class. |
|||
|
|||
#### 1- Add SignalR |
|||
|
|||
Open `YourProjectWebModule.cs` class and add the following line to the `PreConfigureServices` method: |
|||
|
|||
```csharp |
|||
context.Services.AddSignalR(); |
|||
``` |
|||
|
|||
|
|||
|
|||
 |
|||
|
|||
|
|||
|
|||
#### 2- Add Client Scripts |
|||
|
|||
2- In the `ConfigureServices` method of your web module add the following code to add the `signalr.js` and `notification-hub.js`. We'll add these packages in the next steps. |
|||
|
|||
 |
|||
|
|||
#### 3- Add Hub Endpoint |
|||
|
|||
Add the following code to add the notification hub endpoint in `OnApplicationInitialization` method: |
|||
|
|||
```csharp |
|||
app.UseEndpoints(endpoints => |
|||
{ |
|||
endpoints.MapHub<UiNotificationHub>("/notification-hub"); |
|||
}); |
|||
``` |
|||
|
|||
 |
|||
|
|||
### Implement Frontend |
|||
|
|||
We'll write the client-side code to be able to handle the SignalR response. |
|||
|
|||
#### 1- Add Notification Hub |
|||
|
|||
Add the following JavaScript class into your `Pages` folder in your Web project. We already added this script to our global scripts. |
|||
|
|||
[notification-hub.js](https://gist.github.com/ebicoglu/f7dc22cca2d353f8bf7f68a03e3395b8#file-notification-hub-js) |
|||
|
|||
 |
|||
|
|||
#### 2- Add SignalR NPM package |
|||
|
|||
Add [Microsoft.SignalR](https://www.npmjs.com/package/@microsoft/signalr) JavaScript package to the `package.json` which is located in your root folder of the Web project. After you add it, run `yarn` command in your Web directory to be able to install this package. |
|||
|
|||
 |
|||
|
|||
#### 3- Add resource Mapping |
|||
|
|||
We added SignalR to the `package.json` but it comes into your `node_modules` folder. We need to copy the related files to `wwwroot/libs` folder. To do this copy the content of the following file to your `abp.resourcemappings.js` file. It's in your root directory of Web folder. After you do this, go to your web directory and run `gulp` command. By doing this, it'll copy the related files into your `wwwroot/libs` folder. |
|||
|
|||
[abp.resourcemappings.js](https://gist.github.com/ebicoglu/f7dc22cca2d353f8bf7f68a03e3395b8#file-abp-resourcemapping-js) |
|||
|
|||
 |
|||
|
|||
#### 4- Usage |
|||
|
|||
We have completed the implementation part. Let's check if it's running... |
|||
|
|||
To do this easily, open your `Index.cshtml` which is in the Pages folder of your Web project. And replace the content with the following. Also replace the `Index.cshtml.cs` as well. |
|||
|
|||
[Index.cshtml](https://gist.github.com/ebicoglu/f7dc22cca2d353f8bf7f68a03e3395b8#file-index-cshtml) |
|||
|
|||
[Index.cshtml.cs](https://gist.github.com/ebicoglu/f7dc22cca2d353f8bf7f68a03e3395b8#file-index-cshtml-cs) |
|||
|
|||
#### 5- See it in action |
|||
|
|||
Run your web project and in the Index page you'll see a button named as "Get Notification". Click the button and see the notification that comes from SignalR. This is a basic usage of SignalR notification system. You can implement it according to your own requirements. |
|||
|
|||
 |
|||
|
After Width: | Height: | Size: 79 KiB |
|
After Width: | Height: | Size: 90 KiB |
|
After Width: | Height: | Size: 31 KiB |
|
After Width: | Height: | Size: 100 KiB |
|
After Width: | Height: | Size: 68 KiB |
|
After Width: | Height: | Size: 188 KiB |
|
After Width: | Height: | Size: 8.1 KiB |
|
After Width: | Height: | Size: 44 KiB |
|
After Width: | Height: | Size: 75 KiB |
|
After Width: | Height: | Size: 6.0 KiB |
|
After Width: | Height: | Size: 7.4 KiB |
@ -0,0 +1,10 @@ |
|||
{ |
|||
"culture": "zh-Hant", |
|||
"texts": { |
|||
"Volo.Authorization:010001": "認證失敗! Given policy has not granted.", |
|||
"Volo.Authorization:010002": "認證失敗! Given policy has not granted: {PolicyName}", |
|||
"Volo.Authorization:010003": "認證失敗! Given policy has not granted for given resource: {ResourceName}", |
|||
"Volo.Authorization:010004": "認證失敗! Given requirement has not granted for given resource: {ResourceName}", |
|||
"Volo.Authorization:010005": "認證失敗! Given requirements has not granted for given resource: {ResourceName}" |
|||
} |
|||
} |
|||
@ -0,0 +1,54 @@ |
|||
using System; |
|||
using System.Collections.Generic; |
|||
using System.Linq; |
|||
|
|||
namespace Volo.Abp.Cli.ProjectBuilding.Building.Steps |
|||
{ |
|||
public class RemoveProjectFromPrometheusStep : ProjectBuildPipelineStep |
|||
{ |
|||
private readonly string _name; |
|||
|
|||
public RemoveProjectFromPrometheusStep(string name) |
|||
{ |
|||
_name = name; |
|||
} |
|||
|
|||
public override void Execute(ProjectBuildContext context) |
|||
{ |
|||
var tyeFile = context.Files.FirstOrDefault(f => f.Name == "/etc/prometheus/prometheus.yml"); |
|||
|
|||
if (tyeFile == null) |
|||
{ |
|||
return; |
|||
} |
|||
|
|||
var lines = tyeFile.GetLines(); |
|||
var newLines = new List<string>(); |
|||
|
|||
var nameLine = $"- job_name:"; |
|||
var isOneOfTargetLines = false; |
|||
|
|||
foreach (var line in lines) |
|||
{ |
|||
if (line.Trim().Equals($"{nameLine} '{_name}'")) |
|||
{ |
|||
isOneOfTargetLines = true; |
|||
continue; |
|||
} |
|||
|
|||
if (line.Trim().StartsWith(nameLine)) |
|||
{ |
|||
isOneOfTargetLines = false; |
|||
} |
|||
|
|||
if (!isOneOfTargetLines) |
|||
{ |
|||
newLines.Add(line); |
|||
} |
|||
} |
|||
|
|||
tyeFile.SetContent(String.Join(Environment.NewLine, newLines)); |
|||
} |
|||
|
|||
} |
|||
} |
|||
@ -1,12 +1,13 @@ |
|||
using Volo.Abp.Logging; |
|||
using Microsoft.Extensions.Logging; |
|||
using Volo.Abp.Logging; |
|||
|
|||
namespace Microsoft.Extensions.DependencyInjection |
|||
{ |
|||
public static class ServiceCollectionLoggingExtensions |
|||
{ |
|||
public static IInitLogger GetInitLogger(this IServiceCollection services) |
|||
public static ILogger<T> GetInitLogger<T>(this IServiceCollection services) |
|||
{ |
|||
return services.GetSingletonInstance<IInitLogger>(); |
|||
return services.GetSingletonInstance<IInitLoggerFactory>().Create<T>(); |
|||
} |
|||
} |
|||
} |
|||
} |
|||
|
|||
@ -1,26 +1,20 @@ |
|||
using System; |
|||
using JetBrains.Annotations; |
|||
using Microsoft.Extensions.Logging; |
|||
|
|||
namespace Volo.Abp.Logging |
|||
{ |
|||
public class AbpInitLogEntry |
|||
{ |
|||
public LogLevel Level { get; } |
|||
|
|||
public string Message { get; } |
|||
|
|||
[CanBeNull] |
|||
public Exception Exception { get; } |
|||
|
|||
public AbpInitLogEntry( |
|||
LogLevel level, |
|||
string message, |
|||
Exception exception) |
|||
{ |
|||
Level = level; |
|||
Message = message; |
|||
Exception = exception; |
|||
} |
|||
public LogLevel LogLevel { get; set; } |
|||
|
|||
public EventId EventId { get; set; } |
|||
|
|||
public object State { get; set; } |
|||
|
|||
public Exception Exception { get; set; } |
|||
|
|||
public Func<object, Exception, string> Formatter { get; set; } |
|||
|
|||
public string Message => Formatter(State, Exception); |
|||
} |
|||
} |
|||
} |
|||
|
|||
@ -0,0 +1,15 @@ |
|||
using System; |
|||
using System.Collections.Generic; |
|||
|
|||
namespace Volo.Abp.Logging |
|||
{ |
|||
public class DefaultInitLoggerFactory : IInitLoggerFactory |
|||
{ |
|||
private readonly Dictionary<Type, object> _cache = new Dictionary<Type, object>(); |
|||
|
|||
public virtual IInitLogger<T> Create<T>() |
|||
{ |
|||
return (IInitLogger<T>)_cache.GetOrAdd(typeof(T), () => new DefaultInitLogger<T>());; |
|||
} |
|||
} |
|||
} |
|||
@ -1,16 +1,10 @@ |
|||
using System; |
|||
using System.Collections.Generic; |
|||
using System.Collections.Generic; |
|||
using Microsoft.Extensions.Logging; |
|||
|
|||
namespace Volo.Abp.Logging |
|||
{ |
|||
public interface IInitLogger |
|||
public interface IInitLogger<out T> : ILogger<T> |
|||
{ |
|||
public List<AbpInitLogEntry> Entries { get; } |
|||
|
|||
void Log( |
|||
LogLevel logLevel, |
|||
string message, |
|||
Exception exception = null); |
|||
} |
|||
} |
|||
} |
|||
|
|||
@ -0,0 +1,7 @@ |
|||
namespace Volo.Abp.Logging |
|||
{ |
|||
public interface IInitLoggerFactory |
|||
{ |
|||
IInitLogger<T> Create<T>(); |
|||
} |
|||
} |
|||
@ -0,0 +1,8 @@ |
|||
{ |
|||
"culture": "zh-Hant", |
|||
"texts": { |
|||
"Volo.Feature:010001": "功能尚未啟用: {FeatureName}", |
|||
"Volo.Feature:010002": "請求的功能尚未啟用。這些功能被須全部啟用: {FeatureNames}", |
|||
"Volo.Feature:010003": "請求的功能尚未啟用。這些功能至少需啟用一個: {FeatureNames}" |
|||
} |
|||
} |
|||
@ -0,0 +1,6 @@ |
|||
{ |
|||
"culture": "zh-Hant", |
|||
"texts": { |
|||
"hello": "嗨" |
|||
} |
|||
} |
|||
@ -0,0 +1,7 @@ |
|||
{ |
|||
"culture": "zh-Hant", |
|||
"texts": { |
|||
"HelloText": "嗨 {0}", |
|||
"HowAreYou": "你好嗎?" |
|||
} |
|||
} |
|||
@ -1,6 +1,6 @@ |
|||
{ |
|||
"sdk": { |
|||
"version": "5.0.100", |
|||
"version": "5.0.201", |
|||
"rollForward": "latestFeature" |
|||
} |
|||
} |
|||
|
|||
File diff suppressed because it is too large
@ -0,0 +1,56 @@ |
|||
using System; |
|||
using Microsoft.EntityFrameworkCore.Migrations; |
|||
|
|||
namespace Volo.CmsKit.Migrations |
|||
{ |
|||
public partial class BlogPost_CoverImage : Migration |
|||
{ |
|||
protected override void Up(MigrationBuilder migrationBuilder) |
|||
{ |
|||
migrationBuilder.DropTable( |
|||
name: "CmsContents"); |
|||
|
|||
migrationBuilder.AddColumn<Guid>( |
|||
name: "CoverImageMediaId", |
|||
table: "CmsBlogPosts", |
|||
type: "uniqueidentifier", |
|||
nullable: true); |
|||
} |
|||
|
|||
protected override void Down(MigrationBuilder migrationBuilder) |
|||
{ |
|||
migrationBuilder.DropColumn( |
|||
name: "CoverImageMediaId", |
|||
table: "CmsBlogPosts"); |
|||
|
|||
migrationBuilder.CreateTable( |
|||
name: "CmsContents", |
|||
columns: table => new |
|||
{ |
|||
Id = table.Column<Guid>(type: "uniqueidentifier", nullable: false), |
|||
ConcurrencyStamp = table.Column<string>(type: "nvarchar(40)", maxLength: 40, nullable: true), |
|||
CreationTime = table.Column<DateTime>(type: "datetime2", nullable: false), |
|||
CreatorId = table.Column<Guid>(type: "uniqueidentifier", nullable: true), |
|||
DeleterId = table.Column<Guid>(type: "uniqueidentifier", nullable: true), |
|||
DeletionTime = table.Column<DateTime>(type: "datetime2", nullable: true), |
|||
EntityId = table.Column<string>(type: "nvarchar(64)", maxLength: 64, nullable: false), |
|||
EntityType = table.Column<string>(type: "nvarchar(64)", maxLength: 64, nullable: false), |
|||
ExtraProperties = table.Column<string>(type: "nvarchar(max)", nullable: true), |
|||
IsDeleted = table.Column<bool>(type: "bit", nullable: false, defaultValue: false), |
|||
LastModificationTime = table.Column<DateTime>(type: "datetime2", nullable: true), |
|||
LastModifierId = table.Column<Guid>(type: "uniqueidentifier", nullable: true), |
|||
TenantId = table.Column<Guid>(type: "uniqueidentifier", nullable: true), |
|||
Value = table.Column<string>(type: "nvarchar(max)", maxLength: 2147483647, nullable: false) |
|||
}, |
|||
constraints: table => |
|||
{ |
|||
table.PrimaryKey("PK_CmsContents", x => x.Id); |
|||
}); |
|||
|
|||
migrationBuilder.CreateIndex( |
|||
name: "IX_CmsContents_TenantId_EntityType_EntityId", |
|||
table: "CmsContents", |
|||
columns: new[] { "TenantId", "EntityType", "EntityId" }); |
|||
} |
|||
} |
|||
} |
|||
@ -0,0 +1,7 @@ |
|||
/* |
|||
https://jquery.com/upgrade-guide/3.5/#jquery-htmlprefilter-changes
|
|||
*/ |
|||
var rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([a-z][^\/\0>\x20\t\r\n\f]*)[^>]*)\/>/gi; |
|||
jQuery.htmlPrefilter = function (html) { |
|||
return html.replace(rxhtmlTag, "<$1></$2>"); |
|||
}; |
|||
@ -0,0 +1,12 @@ |
|||
using System; |
|||
using Volo.Abp.Application.Dtos; |
|||
|
|||
namespace Volo.CmsKit.Admin.Blogs |
|||
{ |
|||
public class BlogPostGetListInput : PagedAndSortedResultRequestDto |
|||
{ |
|||
public string Filter { get; set; } |
|||
|
|||
public Guid? BlogId { get; set; } |
|||
} |
|||
} |
|||
@ -1,15 +0,0 @@ |
|||
using System; |
|||
using Volo.CmsKit.Entities; |
|||
|
|||
namespace Volo.CmsKit.Contents |
|||
{ |
|||
public static class ContentConsts |
|||
{ |
|||
public static int MaxEntityTypeLength { get; set; } = CmsEntityConsts.MaxEntityTypeLength; |
|||
|
|||
public static int MaxEntityIdLength { get; set; } = CmsEntityConsts.MaxEntityIdLength; |
|||
|
|||
// TODO: consider
|
|||
public static int MaxValueLength { get; set; } = int.MaxValue; |
|||
} |
|||
} |
|||
Some files were not shown because too many files changed in this diff
Loading…
Reference in new issue