歡迎光臨
每天分享高質量文章

.NET CORE與Spring Boot編寫控制台程式應有的優雅姿勢

本文分別說明.NET CORE與Spring Boot 編寫控制台程式應有的“正確”方法,以便.NET程式員、JAVA程式員可以相互學習與加深瞭解,註意本文只介紹用法,不會刻意強調哪種語言或哪種框架寫的控制台程式要好。

本文所說的編寫控制台程式應有的“正確”方法,我把正確二字加上引號,因為沒有絕對的正確,因人而異,因系統設計需求而異,我這裡所謂的正確方法是指使用面向物件,依賴註入IOC,切麵控制AOP等編碼規範來提升程式的性能、整潔度、可讀性、可維護性等,最終達到讓人感覺有點高大上,有點優雅的樣子

先來說說.NET CORE編寫控制台程式,目前網絡上大把的講解ASP.NET CORE的編寫規範,反而對於.NET CORE控制台程式編寫規範介紹比較少,大多停留在Hello Word 程式中,而本文則來講講.NET CORE控制台的編寫規範(應有的優雅姿勢)^ v ^

 如果說不講什麼IOC,DI,AOP等,不講擴展性,規範性,全部面向過程(方法)編程,那估計沒什麼好講的,因為無非就是定義一個class,然後在class中定義一堆的method(方法),如果在方法中需要使用到其它第三方組件,則直接單獨取用,取用後進行簡單封裝util工具類的靜態方法,甚至也不用封裝,直接使用原生的方法,總之全部都是方法調方法。而這裡所演示的編寫控制台方法均是盡可能的使用.NET CORE所具有的特性,只有這樣才能體現出.NET CORE框架的優勢,否則普通控制台程式與.NET CORE控制台程式有什麼區別。

編寫.NET CORE控制台程式優雅姿勢一:(直接使用.NET CORE的 IOC、Logging、Config組件)

代碼如下:

using Microsoft.Extensions.DependencyInjection;

using System;

using Microsoft.Extensions.Logging;

using Microsoft.Extensions.Configuration.Json;

using Microsoft.Extensions.Configuration;

using System.IO;

namespace NetCoreConsoleApp

{

    class Program

    {

        static void Main(string[] args)

        {

            var config = new ConfigurationBuilder()

                                .SetBasePath(Directory.GetCurrentDirectory())

                                .AddJsonFile("appSettings.json", optional: true, reloadOnChange: true).Build();

            var provider = new ServiceCollection()

                                    .AddLogging(configLogging =>

                                    {

                                        configLogging.SetMinimumLevel(LogLevel.Information);

                                        configLogging.AddConsole();

                                    })

                                   .AddScoped(p => config)

                                   .AddScoped()

                                   .BuildServiceProvider();

            var hostService = provider.GetService();

            hostService.RunAsync();

            Console.WriteLine("提示:程式已正常啟動運行,按任意鍵停止運行並關閉程式...");

            Console.ReadLine();

        }

    }

}

using Microsoft.Extensions.Configuration;

using Microsoft.Extensions.Logging;

using System;

using System.Diagnostics;

using System.Threading;

using System.Threading.Tasks;

namespace NetCoreConsoleApp

{

    public class HostService

    {

        private readonly IConfiguration config;

        private readonly ILogger logger;

        public HostService(IConfiguration config, ILogger logger)

        {

            this.config = config;

            this.logger = logger;

        }

        public void RunAsync()

        {

            Task.Run((Action)Execute);

        }

        ///

        /// 控制台核心執行入口方法

        ///

        private void Execute()

        {

            Stopwatch stopwatch = Stopwatch.StartNew();

            for (int i = 1; i <= 100; i++)

            {

                Console.WriteLine("test WriteLine:" + i);

                Thread.Sleep(100);

            }

            stopwatch.Stop();

            logger.LogInformation("Logging - Execute Elapsed Times:{}ms", stopwatch.ElapsedMilliseconds);

        }

    }

}

因為要使用.NET CORE相關核心組件,故需要取用相關的NuGet包(取用包的方式有多種方式),而且預設的.NET CORE控制台只會生成DLL並不會生成EXE啟動程式,故如果僅在WIN系統下使用,還需要設置生成方式等,詳細配置屬性如下:(專案檔案csproj)

 如上代碼雖簡單但代碼編寫順序很關鍵,這裡進行說明一下:

1.因為一般應用程式都會有config檔案,故我們需要先通過new ConfigurationBuilder來設置config檔案的方式及路徑;

2.因為要使用.NET CORE預設的IOC框架,故new ServiceCollection,然後將相關的依賴服務組件註冊到IOC容器中;

3.config、logging 均是一個程式最基本的依賴組件,故將其註冊到IOC容器中,註冊logging有專門的擴展方法(AddLogging),而config沒有則直接使用通過的註冊方法(當然也可以基於ServiceCollection寫一個AddConfiguration擴展方法)

4.控制台需要一個核心的入口方法,用於處理核心業務,不要直接在Program中寫方法,這樣就不能使用IOC,同時也沒有做到職責分明,Program僅是程式啟動入口,業務處理應該有專門的入口,故上述代碼中有HostService類(即:核心宿主服務類, 意為存在於控制臺中的服務處理類,在這個類的構造涵數中列出所需依賴的服務組件,以便實體化時IOC可以自動註入這個引數),並註冊到IOC容器中,當然也可以先定義一個IHostService接口然後實現這個接口。(如果有多個HostService類實體,建議定義一個IHostService接口,接口中只需要入口方法定義即可,如:RunAsync)

5.當各組件初始化設置OK、IOC註冊到位後,就應該通過IOC解析獲得HostService類實體,並執行入口方法:RunAsync,該方法為異步後臺執行,即呼叫該方法後,會在單獨的後臺執行緒處理核心業務,然後主執行緒繼續往下麵走,輸出關閉提示信息,最後的Console.ReadLine();很關鍵,這個是等待輸入流並掛起當前主執行緒,目的大家都知道,不要讓控制台程式關閉。

 通過上述的講解及原始碼展示,有沒有感覺優雅呢?如果覺得這樣還算優雅,那下麵展示的第二種更優雅的姿勢

編寫.NET CORE控制台程式優雅姿勢二:(使用通用主機也稱泛型主機HostBuilder)

代碼如下:Program.cs

using Microsoft.Extensions.DependencyInjection;

using Microsoft.Extensions.Hosting;

using Microsoft.Extensions.Logging;

using NLog.Extensions.Logging;

using Microsoft.Extensions.Configuration;

using System.IO;

using Polly;

using System;

namespace NetCoreConsoleApp

{

    class Program

    {

        static void Main(string[] args)

        {

            var host = new HostBuilder()

                .ConfigureHostConfiguration(configHost =>

                {

                    configHost.SetBasePath(Directory.GetCurrentDirectory());

                })

                .ConfigureAppConfiguration(configApp =>

                {

                    configApp.AddJsonFile("appsettings.json", optional: false, reloadOnChange: true);

                })

                .ConfigureServices((context, services) =>

                {

                    services.AddHostedService();

                })

                .ConfigureLogging((context, configLogging) =>

                {

                    configLogging.ClearProviders();

                    configLogging.SetMinimumLevel(LogLevel.Trace);

                    configLogging.AddNLog(context.Configuration);

                })

                .UseConsoleLifetime()

                .Build();

            host.Run();

        }

    }

}

DemoHostedService類代碼:

using Microsoft.Extensions.Configuration;

using Microsoft.Extensions.Hosting;

using Microsoft.Extensions.Logging;

using System;

using System.Diagnostics;

using System.Threading;

using System.Threading.Tasks;

namespace NetCoreConsoleApp

{

    public class DemoHostedService : IHostedService

    {

        private readonly IConfiguration config;

        private readonly ILogger logger;

        public DemoHostedService(IConfiguration config, ILogger logger)

        {

            this.config = config;

            this.logger = logger;

        }

        public Task StartAsync(CancellationToken cancellationToken)

        {

            Console.WriteLine(nameof(DemoHostedService) + "已開始執行...");

            Stopwatch stopwatch = Stopwatch.StartNew();

            for (int i = 1; i <= 100; i++)

            {

                Console.WriteLine("test WriteLine:" + i);

                Thread.Sleep(100);

            }

            stopwatch.Stop();

            logger.LogInformation("Logging - Execute Elapsed Times:{}ms", stopwatch.ElapsedMilliseconds);

            return Task.FromResult(0);

        }

        public Task StopAsync(CancellationToken cancellationToken)

        {

            Console.WriteLine(nameof(DemoHostedService) + "已被停止");

            return Task.FromResult(0);

        }

    }

}

因為要使用HostBuilder類及相關的.NET CORE組件(如上代碼主要使用到了:Host、Dapper、Nlog、Polly等),故仍需取用相關的NuGet包,詳細配置屬性如下:(專案檔案csproj)

 如上代碼所示,寫過ASP.NET CORE程式的人可能比較眼熟,這與ASP.NET CORE的寫法很類似,是的,你沒有看錯,HostBuilder是通用主機,是可以廣泛應用於非HTTP的環境下,而ASP.NET CORE中的WebHostBuilder 主要用於HTTP WEB環境,使用方式基本類似,都是先定義HostBuilder,然後利用擴展方法註冊、配置各種組件(中間件),最後呼叫Host的Run方法,開啟後臺服務執行,不同的是WebHostBuilder多了屬於HTTP專有的一些屬性及方法及其適用的中間件。

由於這種寫法比較通用,適用於已熟悉.NET CORE或ASP.NET CORE的人群,上手也較簡單,故建議採取這種方式來寫.NET CORE控制台程式。需要註意的是HostBuilder中最重要的是:註冊HostedService 服務,如上代碼中的DemoHostedService即是實現了IHostedService接口的宿主後臺服務類,可以定義多個,然後都註冊到IOC中,最後Host會按註冊先後順序執行多個HostedService服務的StartAsync方法,當停止時同樣會執行多個HostedService服務的StopAsync方法

下麵再來看看使用Spring&Spring; Boot框架來優雅的編寫控制台程式

編寫Spring控制台程式優雅姿勢一:(只取用所必需的spring jar包、logger jar包,追求極簡風)

使用IDEA +MAVEN 創建一個quickstart 控制台專案,在maven POM XML中先取用所必需的spring jar包、logger jar包等,配置如下:

 

然後採取自定義註解類(SpringBeansConfig)的方式註冊相關Bean(包含配置映射類Bean:AppProperties),代碼如下:

package cn.zuowenjun.spring;

import cn.zuowenjun.spring.cn.zuowenjun.spring.services.HostService;

import org.springframework.context.annotation.AnnotationConfigApplicationContext;

import java.io.IOException;

/**

 * Hello world!

 */

public class App {

    public static void main(String[] args) {

        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(SpringBeansConfig.class);

        HostService hostService = applicationContext.getBean(HostService.class);

        hostService.run();

        applicationContext.registerShutdownHook();

        try {

            System.in.read();

        catch (IOException e) {

            System.out.println("等待讀取輸入資料報錯:" + e.getMessage() + ",將直接退出程式!");

        }

    }

}

package cn.zuowenjun.spring;

import org.springframework.beans.factory.annotation.Value;

public class AppProperties {

    @Value("${app.name}")

    private String appName;

    @Value("${app.author}")

    private String appAuthor;

    @Value("${app.test.msg}")

    private String testMsg;

    public String getAppName() {

        return appName;

    }

    public void setAppName(String appName) {

        this.appName = appName;

    }

    public String getAppAuthor() {

        return appAuthor;

    }

    public void setAppAuthor(String appAuthor) {

        this.appAuthor = appAuthor;

    }

    public String getTestMsg() {

        return testMsg;

    }

    public void setTestMsg(String testMsg) {

        this.testMsg = testMsg;

    }

}

package cn.zuowenjun.spring;

import cn.zuowenjun.spring.cn.zuowenjun.spring.services.HostService;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

import org.springframework.context.annotation.PropertySource;

import org.springframework.context.annotation.Scope;

import org.springframework.core.annotation.Order;

@Configuration

@PropertySource(value = "classpath:app.properties", ignoreResourceNotFound = false)

public class SpringBeansConfig {

    @Bean

    @Order(1)

    public HostService hostService() {

        return new HostService();

    }

    @Bean

    @Order(0)

    @Scope("singleton")

    public AppProperties appProperties() {

        return new AppProperties();

    }

}

package cn.zuowenjun.spring.cn.zuowenjun.spring.services;

import cn.zuowenjun.spring.AppProperties;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.util.StopWatch;

import java.util.Collections;

import java.util.concurrent.ExecutorService;

import java.util.concurrent.Executors;

public class HostService {

    private static final Logger LOGGER = LoggerFactory.getLogger(HostService.class);

    @Autowired

    private AppProperties appProperties;

    public void run() {

        new Thread(this::execute).start();

    }

    private void execute() {

        StopWatch stopwatch = new StopWatch();

        stopwatch.start();

        for (int i = 1; i <= 100; i++) {

            System.out.println("test WriteLine:" + i);

            try {

                Thread.sleep(100);

            catch (Exception e) {

            }

        }

        stopwatch.stop();

        System.out.println(String.join("", Collections.nCopies(30"=")));

        System.out.printf("app name is:%s %n", appProperties.getAppName());

        System.out.printf("app author is:%s %n", appProperties.getAppAuthor());

        System.out.printf("app test msg:%s %n", appProperties.getTestMsg());

        LOGGER.info("Logging - Execute Elapsed Times:{}ms", stopwatch.getTotalTimeMillis());

    }

}

 app.properties配置檔案內容如下,註意應放在classpth目錄下(即:resources目錄下,沒有需自行創建並設為resources目錄):

app.name=demo spring console

app.author=zuowenjun

app.test.msg=hello java spring console app!

 如上即上實現一個spring的控制台程式,當然由於是示例,故只取用了logger包,正常還需取用jdbc或ORM框架的相關jar包, 上述代碼關鍵邏輯說明(同樣要註意順序):

1.new AnnotationConfigApplicationContext類(spring IOC容器),創建一個IOC容器,類似.NET CORE中的ServiceProvider類;

2.定義 SpringBeansConfig bean註冊配置類(註冊相關依賴),這個類中依次註入相關的bean,如果bean之間有依賴順序關係,建議添加@Order並指明序號;該類作為AnnotationConfigApplicationContext的建構式引數傳入,以便IOC自動解析並完成實際註冊;

3.同樣是定義一個HostService 宿主服務類,並實現run方法邏輯,一般採取後臺執行緒異步執行,為了演示效果與.NET CORE的HostService 類相同,示例邏輯基本相同。另外還定義了AppProperties配置映射類,便於直接讀取配置,.NET CORE同樣也有類似註冊bind到配置類中,然後在服務類中使用:IOptions作為建構式引數實現建構式註入。只是由於篇幅有限故.NET CORE部份直接採取了註入IConfiguration,大家有興趣可以查看網上相關資料。

4.IOC容器初始化並註冊成功後,即可解析HostService 類獲得實體,執行run方法,run方法會開啟執行緒在後臺處理,並傳回到主執行緒,直至in.read()阻塞掛起主執行緒,防止程式自動關閉。

編寫Spring boot控制台程式優雅姿勢二:(取用spring boot jar包)

 使用IDEA+Spring Initializr來創建一個spring boot專案,創建過程中按需選擇依賴的框架,我這裡是示例,故除了預設spring-boot-starter依賴外,其餘什麼依賴都不添加,創建後Maven POM XML如下:

View Code

然後創建相關的Bean類:HostService(宿主服務類,這個與前文定義類均相同)、AppProperties(配置映射類,這個是映射預設的application.properties配置檔案,註意這裡的映射方式與前文所描述稍有不周,採用:@ConfigurationProperties+屬性映射,無需加@Value註解,映射屬性時如果有-則應寫成駝峰式,如果有.則應定義內部靜態類,呈現層級屬性完成映射,具體的用法可以參見我之前的文章):

package cn.zuowenjun.spring.services;

import cn.zuowenjun.spring.AppProperties;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.stereotype.Component;

import org.springframework.util.StopWatch;

import java.util.Collections;

@Component

public class HostService {

    private static final Logger LOGGER = LoggerFactory.getLogger(HostService.class);

    @Autowired

    private AppProperties appProperties;

    public void run() {

        new Thread(this::execute).start();

    }

    private void execute() {

        StopWatch stopwatch = new StopWatch();

        stopwatch.start();

        for (int i = 1; i <= 100; i++) {

            System.out.println("test WriteLine:" + i);

            try {

                Thread.sleep(100);

            catch (Exception e) {

            }

        }

        stopwatch.stop();

        System.out.println(String.join("", Collections.nCopies(30"=")));

        System.out.printf("app name is:%s %n", appProperties.getName());

        System.out.printf("app author is:%s %n", appProperties.getAuthor());

        System.out.printf("app test msg:%s %n", appProperties.getTestMsg());

        LOGGER.info("Logging - Execute Elapsed Times:{}ms", stopwatch.getTotalTimeMillis());

    }

}

package cn.zuowenjun.spring;

import org.springframework.boot.context.properties.ConfigurationProperties;

import org.springframework.stereotype.Component;

@Component

@ConfigurationProperties(prefix = "app")

public class AppProperties {

    private String name;

    private String author;

    private String testMsg;

    public String getName() {

        return name;

    }

    public void setName(String name) {

        this.name = name;

    }

    public String getAuthor() {

        return author;

    }

    public void setAuthor(String author) {

        this.author = author;

    }

    public String getTestMsg() {

        return testMsg;

    }

    public void setTestMsg(String testMsg) {

        this.testMsg = testMsg;

    }

}

application.properties配置檔案:(註意app.test.msg此處改為了app.test-msg,因為這樣就可以直接映射到類的屬性中,否則得定義內部類有點麻煩)

app.name=demo spring console

app.author=zuowenjun

app.test-msg=hello java spring console app!

 最後改造spring boot application類,讓SpringbootConsoleApplication類實現ApplicationRunner接口,併在run方法中編寫通過屬性依賴註入獲得HostService類的實體,最後執行HostService的run方法即可,代碼如下:

package cn.zuowenjun.spring;

import cn.zuowenjun.spring.services.HostService;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.boot.ApplicationArguments;

import org.springframework.boot.ApplicationRunner;

import org.springframework.boot.SpringApplication;

import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication

public class SpringbootConsoleApplication implements ApplicationRunner {

    @Autowired

    private HostService hostService;

    public static void main(String[] args) {

        SpringApplication.run(SpringbootConsoleApplication.class, args);

    }

    @Override

    public void run(ApplicationArguments args) throws Exception {

        hostService.run();

    }

}

 如上步驟即完成了優雅編寫spring boot控制台程式,關鍵點是ApplicationRunner,這個是給spring boot執行的入口,另一種思路,我們其實還可以把HostService類改造一下,讓其實現ApplicationRunner接口,那麼run方法即為spring boot的啟動入口。

總結一下:.

NET CORE控制台程式優雅姿勢一與Spring控制台優雅姿勢一核心思想是一樣的,都是手動創建各個依賴組件及IOC容器的實體,都是通過IOC容器顯式的解析獲得HostService類的實體,最後運行HostService#run方法。

NET CORE控制台程式優雅姿勢二與Spring控制台優雅姿勢二核心思想也是一樣的,都是利用IOC容器來直接管理註冊的各個依賴組件,並由.NET CORE、Spring boot框架自行調度HostService#run方法。

我個人更傾向優雅姿勢二的方法來編寫.NET CORE或Spring Boot的控制台程式,因為寫得更少,做得更多。

已同步到看一看
赞(0)

分享創造快樂