Dela via

Självstudie: Skapa ett .NET-klassbibliotek med Visual Studio Code

  • Artikel

I den här handledningen skapar du ett enkelt hjälpbibliotek som innehåller en enda stränghanteringsmetod.

Ett klassbibliotek definierar typer och metoder som anropas av ett program. Om biblioteket är avsett för .NET Standard 2.0 kan det anropas av alla .NET-implementeringar (inklusive .NET Framework) som stöder .NET Standard 2.0. Om biblioteket är avsett för .NET 9 kan det anropas av alla program som riktar sig till .NET 9. Den här självstudien visar hur du riktar in dig på .NET 9.

När du skapar ett klassbibliotek kan du distribuera det som en komponent från tredje part eller som en paketerad komponent med ett eller flera program.

Förutsättningar

Installationsanvisningar

På Windows används den här WinGet-konfigurationsfilen för att installera alla krav. Om du redan har något installerat hoppar WinGet över det steget.

  1. Ladda ned filen och dubbelklicka för att köra den.
  2. Läs licensavtalet, skriv yoch välj Ange när du uppmanas att acceptera.
  3. Om du får en flashande UAC-fråga (User Account Control) i aktivitetsfältet tillåter du att installationen fortsätter.

På andra plattformar måste du installera var och en av dessa komponenter separat.

  1. Ladda ned det rekommenderade installationsprogrammet från nedladdningssidan .NET SDK och dubbelklicka för att köra det. Nedladdningssidan identifierar din plattform och rekommenderar den senaste installationsprogrammet för din plattform.
  2. Ladda ned det senaste installationsprogrammet från Visual Studio Code startsida och dubbelklicka för att köra det. Den sidan identifierar även din plattform och länken bör vara korrekt för ditt system.
  3. Klicka på knappen "Installera" på sidan C# DevKit tillägg. Då öppnas Visual Studio-kod och du tillfrågas om du vill installera eller aktivera tillägget. Välj "installera".

Skapa ett klassbiblioteksprojekt

Börja med att skapa ett .NET-klassbiblioteksprojekt med namnet "StringLibrary" och en associerad lösning. En lösning fungerar som en container för ett eller flera projekt. Du lägger till ytterligare relaterade projekt i samma lösning.

  1. Starta Visual Studio Code.

  2. Gå till Utforskarvyn och välj Skapa .NET Project. Du kan också ta upp kommandopaletten med hjälp av Ctrl+Skift+P (Kommando+Skift+P på MacOS) och sedan skriva ".NET" och leta upp och välja kommandot .NET: New Project.

  3. När du har valt kommandot måste du välja projektmallen. Välj Klassbibliotek.

  4. Välj sedan den plats där du vill att det nya projektet ska skapas.

  5. Välj sedan den plats där du vill att det nya projektet ska skapas: Skapa en mapp med namnet ClassLibraryProjects och välj den.

  6. Ge projektet namnet StringLibrary, välj Visa alla mallalternativ, välj .NET 9 och välj Skapa projekt.

  7. Ge projektet namnet StringLibrary och välj Skapa projekt.

  8. Tryck på Retur vid prompten Projektet skapas i <sökväg>.

  9. Kontrollera att biblioteket är avsett för .NET 9. I Exploreröppnar du StringLibrary/StringLibrary.csproj.

    Elementet TargetFramework visar att projektet riktar in sig på .NET 9.0.

    <Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <TargetFramework>net9.0</TargetFramework>
  </PropertyGroup>

</Project>

  10. Öppna Class1.cs och ersätt koden med följande kod.

    using System;

namespace UtilityLibraries
{
    public static class StringLibrary
    {
        public static bool StartsWithUpper(this string str)
        {
            if (string.IsNullOrWhiteSpace(str))
                return false;

            char ch = str[0];
            return char.IsUpper(ch);
        }
    }
}

    Klassbiblioteket UtilityLibraries.StringLibraryinnehåller en metod med namnet StartsWithUpper. Den här metoden returnerar ett Boolean värde som anger om den aktuella stränginstansen börjar med ett versalt tecken. Unicode-standarden skiljer versaler från gemener. Metoden Char.IsUpper(Char) returnerar true om ett tecken är versaler.

    StartsWithUpper implementeras som en tilläggsmetod så att du kan anropa den som om den vore medlem i klassen String.

  11. Spara filen.

  12. Öppna Solution Explorer längst ned i Explorer vyn.

  13. Högerklicka på lösningen i Solution Explorer och välj Build, eller öppna kommandopaletten och välj .NET: Skapa för att skapa lösningen och kontrollera att projektet kompileras utan fel.

    Terminalutdata ser ut som i följande exempel:

    Microsoft (R) Build Engine version 17.8.0+b89cb5fde for .NET
Copyright (C) Microsoft Corporation. All rights reserved.
  Determining projects to restore...
  All projects are up-to-date for restore.
  StringLibrary -> C:\Projects\ClassLibraryProjects\StringLibrary\bin\Debug\net9.0\StringLibrary.dll
Build succeeded.
    0 Warning(s)
    0 Error(s)
Time Elapsed 00:00:02.78

Lägga till en konsolapp i lösningen

Lägg till ett konsolprogram som använder klassbiblioteket. Appen uppmanar användaren att ange en sträng och rapportera om strängen börjar med ett versalt tecken.

  1. Högerklicka på lösningen i Solution Explorer och välj Nytt projekt, eller välj .NET: New Projecti kommandopaletten.

  2. Välj Konsolapp.

  3. Ge den namnet ShowCase, välj standardplatsen och välj Skapa projekt.

  4. Öppna ShowCase/Program.cs och ersätt all kod med följande kod.

    using System;
using UtilityLibraries;

class Program
{
    static void Main(string[] args)
    {
        int row = 0;

        do
        {
            if (row == 0 || row >= 25)
                ResetConsole();

            string? input = Console.ReadLine();
            if (string.IsNullOrEmpty(input)) break;
            Console.WriteLine($"Input: {input} {"Begins with uppercase? ",30}: " +
                              $"{(input.StartsWithUpper() ? "Yes" : "No")}{Environment.NewLine}");
            row += 3;
        } while (true);
        return;

        // Declare a ResetConsole local method
        void ResetConsole()
        {
            if (row > 0)
            {
                Console.WriteLine("Press any key to continue...");
                Console.ReadKey();
            }
            Console.Clear();
            Console.WriteLine($"{Environment.NewLine}Press <Enter> only to exit; otherwise, enter a string and press <Enter>:{Environment.NewLine}");
            row = 3;
        }
    }
}

    Koden använder variabeln row för att upprätthålla antalet rader med data som skrivits till konsolfönstret. När den är större än eller lika med 25 rensar koden konsolfönstret och visar ett meddelande till användaren.

    Programmet uppmanar användaren att ange en sträng. Det anger om strängen börjar med ett versalt tecken. Om användaren trycker på Retur utan att ange en sträng avslutas programmet och konsolfönstret stängs.

  5. Spara ändringarna.

Lägga till en projektreferens

Till en början har det nya konsolappprojektet inte åtkomst till klassbiblioteket. Om du vill tillåta att den anropar metoder i klassbiblioteket skapar du en projektreferens till klassbiblioteksprojektet.

  1. I Solution Explorer högerklicka på projektet ShowCase och välj Lägg till projektreferens.

  2. Välj StringLibrary.

Kör appen

  1. Välj Kör>Kör utan att felsöka.

  2. Välj C#.

  3. Välj ShowCase.

    Om du får ett felmeddelande om att inget C#-program har lästs in stänger du mappen som du har öppnat och öppnar mappen ShowCase. Försök sedan att köra appen igen.

  4. Prova programmet genom att ange strängar och trycka på Returoch tryck sedan på Retur för att avsluta.

    Terminalutdata ser ut som i följande exempel:

    Press <Enter> only to exit; otherwise, enter a string and press <Enter>:

A string that starts with an uppercase letter
Input: A string that starts with an uppercase letter
Begins with uppercase? : Yes

a string that starts with a lowercase letter
Input: a string that starts with a lowercase letter
Begins with uppercase? : No

Ytterligare resurser

Nästa steg

I den här självstudien skapade du ett biblioteksprojekt och lade till ett konsolappprojekt som använder biblioteket. I nästa handledning lägger du till ett enhetstestprojekt i lösningen.

Testa ett .NET-klassbibliotek med .NET med Visual Studio Code