Egal, ob es deine Aufgabe ist, die Codebase oder das Framework zu modernisieren, indem du zu einer neuen Programmiersprache wechselst, oder ob du mehr über neue Funktionen in dieser Sprache erfahren möchtest: das KI-gestützte GitLab Duo kann dir dabei helfen. Hier erfährst du anhand von Beispielen aus meiner 20-jährigen Berufserfahrung als Programmier(in), wie du Herausforderungen beim Code-Refactoring am besten meisterst.
Die Prompts und Beispiele in diesem Artikel werden in verschiedenen IDEs gezeigt: VS Code und JetBrains (IntelliJ IDEA, PyCharm und CLion) mit den jeweiligen installierten (GitLab-Duo-Erweiterungen/Plugins]https://docs.gitlab.com/ee/user/project/repository/code_suggestions/supported_extensions.html). Die Entwicklungsumgebung nutzt GitLab.com, darunter Updates auf Anthropic Claude 3.5 als großes Sprachmodell (LLM) für Codevorschläge und den Chat von GitLab Duo. Spoiler: Sie sind noch leistungsstärker und effizienter.
Du kannst zu den einzelnen Abschnitten dieses Artikels springen oder ihn von Anfang bis Ende lesen. Der Quellcode und die Herausforderungen mit den jeweiligen Übungen sind zum Selbststudium geeignet.
- Code in moderne Programmiersprachen-Standards refaktorieren
- Eine Sprache in eine andere refaktorisieren
- Weitere Tipps zum Refaktorisieren
- Wichtige Erkenntnisse
Code in moderne Programmiersprachen-Standards refaktorisieren
Im nächsten Abschnitt erfährst du, wie du die sprachspezifischen Unterschiede einer Programmiersprache refaktorisierst, erklärst und verstehst.
Java 7 generieren und auf Java 8 refaktorisieren
Ein Kunde wollte wissen, ob GitLab Duo Java 7 unterstützt. Beim Testen von Codevorschlägen und Chat-Prompts, um spezifischen Code für Java 7 zu erstellen, dachte ich auch über Hilfe bei der Migration nach. Anthropic Claude 3.5 kann die sprachspezifischen Unterschiede verstehen, ebenso wie GitLab Duo.
Das folgende Beispiel zeigt eine Aufforderung zum Generieren von Java-7-Code mit Codevorschlägen.
// Generate a new class for a File Manager. Use Java 7 features only.
import java.io.*;
import java.nio.file.*;
import java.util.*;
public class FileManager {
private Path rootDirectory;
public FileManager(String rootPath) throws IOException {
this.rootDirectory = Paths.get(rootPath);
if (!Files.exists(rootDirectory)) {
Files.createDirectories(rootDirectory);
}
}
public void createFile(String fileName, String content) throws IOException {
Path filePath = rootDirectory.resolve(fileName);
Files.write(filePath, content.getBytes(), StandardOpenOption.CREATE, StandardOpenOption.TRUNCATE_EXISTING);
}
public String readFile(String fileName) throws IOException {
Path filePath = rootDirectory.resolve(fileName);
return new String(Files.readAllBytes(filePath));
}
public void deleteFile(String fileName) throws IOException {
Path filePath = rootDirectory.resolve(fileName);
Files.delete(filePath);
}
public List<String> listFiles() throws IOException {
List<String> fileList = new ArrayList<>();
try (DirectoryStream<Path> stream = Files.newDirectoryStream(rootDirectory)) {
for (Path file : stream) {
fileList.add(file.getFileName().toString());
}
}
return fileList;
}
public void copyFile(String sourceFileName, String destinationFileName) throws IOException {
Path sourcePath = rootDirectory.resolve(sourceFileName);
Path destinationPath = rootDirectory.resolve(destinationFileName);
Files.copy(sourcePath, destinationPath, StandardCopyOption.REPLACE_EXISTING);
}
public void moveFile(String sourceFileName, String destinationFileName) throws IOException {
Path sourcePath = rootDirectory.resolve(sourceFileName);
Path destinationPath = rootDirectory.resolve(destinationFileName);
Files.move(sourcePath, destinationPath, StandardCopyOption.REPLACE_EXISTING);
}
public long getFileSize(String fileName) throws IOException {
Path filePath = rootDirectory.resolve(fileName);
return Files.size(filePath);
}
public boolean fileExists(String fileName) {
Path filePath = rootDirectory.resolve(fileName);
return Files.exists(filePath);
}
}
Du kannst mit folgenden Schritten in deinem IDE fortfahren:
- Lerne und verstehe den generierten Code: Wähle den Code im Editor aus (im Screenshot blau), wechsle zum GitLab-Duo-Chat und sende den Slash-Befehl
/explain
als Prompt.
- Wandle den Java-7-Code in Java 8 um: Wähle den Code im Editor aus, wechsle zum Chat und sende
/refactor using Java 8 features
als detaillierteren Prompt. - Übe eine Alternative zum Refactoring: Erstelle die neue Datei
java8.java
und generiere Java-8-spezifischen Code mit Codevorschlägen mit dem Prompt// Generate a new class for a File Manager. Use Java 8 features only.
. - Schreibe weiter Java-8-Code im gleichen Kontext mit KI-basierter Code-Vervollständigung.
Du kannst dir alle Schritte in dieser Aufnahme ansehen.
Der Quellcode ist in der GitLab-Duo-Challenge – Java 7 generieren und auf Java 8 refaktorisieren verfügbar.
Über C++-Standards refaktorisieren
Der C++-Standard hat eine lange Geschichte und gilt als stabil und ausgereift. Je nach Zielarchitektur und Plattformen hängt der unterstützte Standard vom Compiler des Host-Betriebssystems ab.
In meiner Karriere musste ich bereits 25 verschiedene Linux- und Windows-Distributionen in Open-Source-Projekten supporten und habe unterschiedlichsten Compiler-Support für neuere Sprachfunktionen und C++-Standards erlebt. Im Jahr 2015 haben wir uns für C++11-Funktionen entschieden und später C++14 oder C++17 nie mehr angerührt.
Die Refaktorisierung von Funktionen und Algorithmen zu einem neuen C++-Standard wäre zu aufwändig gewesen und es wäre Hilfe beim Erklären der Unterschiede nötig gewesen. Damals haben wir in Büchern, über Online-Suche, Stack Overflow und manchmal Tools Hilfe zum Refactoring gesucht.Mit KI-basierten Assistenten und GitLab Duo hat sich das alles geändert: Du kannst Codevorschläge und den Chat nutzen, um Quellcode in einem bestimmten C++-Standard bereitzustellen. Dann ist es auch möglich, die verschiedenen Ausgaben zu vergleichen.
Das folgende Beispiel verwendet einen Prompt, um speziell Quellcode für den C++03-Standard zu generieren. Es implementiert einen einfachen Konfigurations-Parser für das Konfigurationsformat .ini
.
/* Create a config parser which can parse an ini format
Use C++03 standard only
*/
#include <iostream>
#include <fstream>
#include <string>
#include <map>
#include <sstream>
class ConfigParser {
private:
std::map<std::string, std::map<std::string, std::string> > config;
public:
ConfigParser() {}
bool parse(const std::string& filename) {
std::ifstream file(filename.c_str());
if (!file.is_open()) {
return false;
}
std::string line;
std::string currentSection;
while (std::getline(file, line)) {
// Trim whitespace
size_t first = line.find_first_not_of(" \t");
size_t last = line.find_last_not_of(" \t");
if (first == std::string::npos) continue; // Skip empty lines
line = line.substr(first, (last - first + 1));
if (line[0] == '[' && line[line.length() - 1] == ']') {
// This is a section
currentSection = line.substr(1, line.length() - 2);
} else {
// This is a key-value pair
size_t delimiterPos = line.find('=');
if (delimiterPos != std::string::npos) {
std::string key = line.substr(0, delimiterPos);
std::string value = line.substr(delimiterPos + 1);
config[currentSection][key] = value;
}
}
}
file.close();
return true;
}
std::string getValue(const std::string& section, const std::string& key) const {
std::map<std::string, std::map<std::string, std::string> >::const_iterator sectionIt = config.find(section);
if (sectionIt != config.end()) {
std::map<std::string, std::string>::const_iterator keyIt = sectionIt->second.find(key);
if (keyIt != sectionIt->second.end()) {
return keyIt->second;
}
}
return "";
}
void printConfig() const {
std::map<std::string, std::map<std::string, std::string> >::const_iterator sectionIt;
for (sectionIt = config.begin(); sectionIt != config.end(); ++sectionIt) {
std::cout << "[" << sectionIt->first << "]" << std::endl;
std::map<std::string, std::string>::const_iterator keyIt;
for (keyIt = sectionIt->second.begin(); keyIt != sectionIt->second.end(); ++keyIt) {
std::cout << keyIt->first << " = " << keyIt->second << std::endl;
}
std::cout << std::endl;
}
}
};
int main() {
ConfigParser parser;
if (parser.parse("config.ini")) {
std::cout << "Config file parsed successfully." << std::endl;
parser.printConfig();
std::cout << "Value of 'key1' in 'section1': " << parser.getValue("section1", "key1") << std::endl;
} else {
std::cout << "Failed to parse config file." << std::endl;
}
return 0;
}
The same prompts can be applied to explaining code, generating tests, and even refactoring code: /explain focus on C++03 features
, /tests for C++03 features
, /refactor into C++03
.
Die folgenden C+ -Standards wurden für die Arbeit mit GitLab Duo Codevorschläge getestet:
- C++03
- C++11
- C++14
- C++17
- C++20
- C++23
Den Quellcode findest du in der Challenge – Cpp-Standards Konfigurations-Parser refaktorisieren.
Es gibt viele verschiedene Kombinationen, um den Quellcode zwischen den C++-Standards zu refaktorisieren. Die folgenden Beispiele zeigen eine Modernisierung des C++-Codes mit Versionsupgrades, testen aber auch ein Downgrade, als ambitionierte Entwickler(innen) C++20 verwenden wollten, aber C++11 verwenden mussten, um den Umgebungen ihrer Geschäftskund(inn)en zu entsprechen.#### Migration: C++03 in C++14 refaktorisieren
Das Ziel ist es, den Code zu modernisieren und die Veränderungen zwischen C++03 und C++14 zu verstehen. Öffne den 03.cpp-Quellcode in der IDE, wähle ihn aus und gib den folgenden Chat-Prompt ein:
/refactor into C++14 and explain the changes
Potentielle Antwort des Chats:
…
Explanations of the changes:
1. Default constructor: Changed `ConfigParser() {}` to `ConfigParser() = default;` to use the default constructor.
2. File opening: Removed `.c_str()` when opening the file, as C++11 and later support `std::string` directly.
3. Lambda functions: Introduced a lambda function trim to handle string trimming, making the code more readable and reusable.
4. Auto keyword: Used `auto` for type deduction in various places, improving code readability.
5. Range-based for loops: In the `printConfig` method, replaced traditional for loops with range-based for loops, which are more concise and less error-prone.
6. Structured bindings: Used structured bindings in the range-based for loops to directly access key-value pairs.
7. If statements with initializers: In the `getValue` method, used if statements with initializers to combine the find operation and the check in a single line.
8. String member functions: Used `front()` and `back()` instead of array-style access for the first and last characters of strings.
9. Uniform initialization: Used uniform initialization `{}` instead of parentheses `()` for object creation.
10. Removed `std::endl`: Replaced `std::endl` with `'\n'` for better performance, as `std::endl` forces a flush of the output buffer.
These changes make the code more modern, concise, and potentially more efficient while maintaining the same functionality.
Downgrade: C++23 zu C++11 refaktorisieren
Manchmal starten Entwickler(innen) einen neuen Proof of Concept in einem modernen C++-Standard wie C++20. Die aktuell unterstützten Versionen für Geschäftskundenumgebungen erfordern ältere Compiler mit C++11-Unterstützung. Ein Downgrade der Versionen ist mit Kosten verbunden und erfordert eine Bewertung, welche Sprachfunktionen noch unterstützt werden und welche anderen Nachteile auftreten könnten.
Öffne den 23.cpp-Quellcode in der IDE, wähle ihn aus und gib den folgenden Chat-Prompt ein:
/refactor into C++11, explain the necessary changes and potential problems
Potenzielle Antwort des Duo Chat:
The main changes required to make this code compatible with C++11 are:
1. Remove the C++23 standard comment, as it's no longer applicable.
2. Replace `std::string::find_first_not_of` and `std::string::find_last_not_of` with C++11 compatible alternatives in the trim function.
3. Use `const auto&` instead of `auto` for loop variables to avoid unnecessary copying.
Potential problems in the original code:
1. The original code used C++23 features, which might not be widely supported yet.
2. The `trim` function used `std::string::find_first_not_of` and `std::string::find_last_not_of`, which are not available in C++11.
3. The use of `auto` instead of `const auto&` in some loops could lead to unnecessary copying of complex objects.
These issues have been addressed in the refactored version. The `trim` function now uses `std::find_if_not` with lambda functions to achieve the same result in a C++11 compatible way. The use of `const auto&` ensures that no unnecessary copying occurs when iterating over the config map.
Asynchronisierungsübung: Teste weitere Refactoring-Szenarios.
COBOL erklären und umgestalten
Du kannst GitLab Duo verwenden, um den Quellcode zu erklären, zu analysieren, zu reparieren und für COBOL-Programme zu refaktorisieren. Ich habe COBOL nie geschrieben oder gelernt und fand diesen COBOL-Programmierkurs mit vielen Beispielen hilfreich.
Ich habe dann den Chat gefragt, wie man mit COBOL beginnt, ein COBOL-Programm erstellt und ein COBOL-Programm auf macOS kompiliert.
Please explain what COBOL is and its syntax
Please create a COBOL program that shows the first steps
Tell me more about the COBOL compiler. Which system do I need? Can I do it on my macOS?
Öffne ein COBOL-Programm, wähle den Quellcode aus, gehe zum Duo Chat und sende den Prompt /explain
, um Zweck und Funktion des Codes zu erklären.
Du kannst die Prompts auch verfeinern, um allgemeinere Zusammenfassungen zu erhalten, zum Beispiel:
/explain like I am five
Tipp: Programmiersprachen haben ähnliche Algorithmen und Funktionen. Für COBOL bot der Chat an, es mit Python zu erklären. Deshalb habe ich die folgenden Prompts angepasst, um in Python nach einer Erklärung zu fragen.
/explain in a different programming language
Du kannst auch den Slash-Befehl /refactor
im Chat verwenden, um die Codequalität zu verbessern, potenzielle Probleme zu beheben und zu versuchen, COBOL in Python zu refaktorisieren.
/refactor fix the environment error
/refactor fix potential problems
/refactor into Python
Die Aufzeichnung GitLab Duo Coffee Chat – Herausforderung: COBOL-Programme erklären und refaktorisieren zeigt die Schritte, die ich oben erklärt habe, anhand eines praktischen Beispiels. Hier siehst du auch, wie man einen fehlenden Punkt finden kann:
Eine Sprache in eine andere Sprache refaktorisieren
Modernisierung und Verbesserungen der Codequalität erfordern manchmal den Wechsel einer Programmiersprache. Ähnliche Refactoring-Prompts mit GitLab Duo können den Migrationsprozess beschleunigen. Das COBOL-Beispiel mit Python ist nur eine von vielen Anforderungen in Unternehmensumgebungen. Sehen wir uns nun weitere Anwendungsfälle an.
C in Rust refaktorisieren
Anfang 2024 wurden mehrere Programmiersprachen, darunter C, als nicht speichersicher bezeichnet. Die Empfehlungen für zukünftige Projekte umfassen speichersichere Sprachen wie Rust. Aber wie startet man eine Migration und welche Herausforderungen gibt es dabei?
Versuchen wir es mit einem einfachen Beispiel in C. Der Code wurde mithilfe von Codevorschlägen generiert und sollte die grundlegenden Betriebssysteminformationen wie Name, Version und Plattform ausdrucken. Der C-Code kompiliert plattformübergreifend unter Windows, Linux und macOS.
// Read OS files to identify the platform, name, versions
// Print them on the terminal
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#ifdef _WIN32
#include <windows.h>
#elif __APPLE__
#include <sys/utsname.h>
#else
#include <sys/utsname.h>
#endif
void get_os_info() {
#ifdef _WIN32
OSVERSIONINFOEX info;
ZeroMemory(&info, sizeof(OSVERSIONINFOEX));
info.dwOSVersionInfoSize = sizeof(OSVERSIONINFOEX);
GetVersionEx((OSVERSIONINFO*)&info);
printf("Platform: Windows\n");
printf("Version: %d.%d\n", info.dwMajorVersion, info.dwMinorVersion);
printf("Build: %d\n", info.dwBuildNumber);
#elif __APPLE__
struct utsname sys_info;
uname(&sys_info);
printf("Platform: macOS\n");
printf("Name: %s\n", sys_info.sysname);
printf("Version: %s\n", sys_info.release);
#else
struct utsname sys_info;
uname(&sys_info);
printf("Platform: %s\n", sys_info.sysname);
printf("Name: %s\n", sys_info.nodename);
printf("Version: %s\n", sys_info.release);
#endif
}
int main() {
get_os_info();
return 0;
}
Öffne den Quellcode in os.c
, beispielsweise in JetBrains CLion. Wähle den Quellcode aus und gib den Chat-Prompt /explain
ein, um Zweck und Funktion erklären zu lassen. Gib als Nächstes /refactor
in den Chat ein, um den C-Code zu refaktorisieren, und gehe dann einen Schritt weiter: /refactor into Rust
.
Initialisiere ein neues Rust-Projekt (Tipp: Frage den Duo Chat) und kopiere den generierten Quellcode in die Datei src/main.rs
. Führe cargo build
aus, um den Code zu kompilieren.
In der Aufzeichnung von GitLab Duo Coffee Chat: Herausforderung – C zu Rust refaktorisieren lernst du alle Schritte kennen und siehst außerdem einen Kompilierungsfehler, der mithilfe des Chats und des Slash-Vefehls /refactor
behoben wird. Die Aufzeichnung zeigt auch, wie man die Wartbarkeit des neuen Rust-Codes verbessern kann, indem man mehr Fehlerbehandlung hinzufügt.
Perl zu Python refaktorisieren
Dieses eine Skript, das auf Produktionsservern läuft, seinen Job macht und dessen Autor(in) schon seit zehn Jahren nicht mehr im Unternehmen arbeitet – und das niemand anfassen will. Dieses Problem kann es auch für mehrere Skripte oder sogar für eine ganze Anwendung geben. Dann wird beschlossen, alles auf das moderne Python 3 zu migrieren, mit dem Ziel, den Code zu modernisieren und die Veränderungen zwischen Perl und Python zu verstehen.
Ein(e) Kund(in) hat kürzlich in einem GitLab-Duo-Workshop gefragt, ob eine direkte Migration mit GitLab Duo möglich ist. Die kurze Antwort: Ja, das ist es. Die längere Antwort: Du kannst mithilfe verfeinerter Chat-Prompts Perl-Code in Python refaktorisieren, ähnlich wie bei anderen Beispielen in diesem Artikel.
Öffne den Quellcode script.pl
in der IDE, wähle ihn aus und öffne den Chat.
#!/usr/bin/perl
use strict;
use warnings;
open my $md_fh, '<', 'file.md' or die "Could not open file.md: $!";
my $l = 0;
my $e = 0;
my $h = 0;
while (my $line = <$md_fh>) {
$l++;
if ($line =~ /^\s*$/) {
$e++;
next;
}
if ($line =~ /^#+\s*(.+)/) {
print "$1\n";
$h++;
}
}
print "\nS:\n";
print "L: $l\n";
print "E: $e\n";
print "H: $h\n";
You can use the following prompts to:
/explain
its purpose, and/refactor
to improve the code./refactor into Python
, um ein funktionierendes Python-Skript zu erhalten.
Tipp: Du kannst Perl-Code in mehrere Zielsprachen refaktorisieren. Die Aufzeichnung von GitLab Duo Coffee Chat: Herausforderung – Perl zu Python refaktorisieren zeigt Refaktorisierungen zu PHP, Ruby, Rust, Go, Java, VB.NET, C# und mehr.
Wenn du Perl-Skripts weiterhin verwenden möchtest, kannst du Perl als zusätzliche Sprache in Duo Codevorschläge konfigurieren. Der Chat versteht bereits Perl und kann bei Fragen und Slash-Befehlen helfen, wie du in der folgenden Aufnahme sehen kannst.
Weitere Tipps zum Refaktorisieren
JavaScript refaktorisieren
Eddie Jaoude zeigt in einem praktischen Beispiel, wie er JavaScript refaktorisiert, um die Codequalität zu verbessern oder Funktionen hinzuzufügen.
Bash zu ZSH oder SH refaktorisieren
Ich benutze Bash seit 20 Jahren als Shell und bin zuletzt auf macOS auf ZSH umgestiegen. Dies führte dazu, dass das Skript nicht funktionierte oder unbekannte Fehler in meinem Terminal auftraten. Ein weiterer Anwendungsfall für das Refactoring sind Shell-Einschränkungen – einige Betriebssysteme oder Linux-/Unix-Distributionen bieten kein Bash, sondern nur SH, z. B. Alpine.
Der GitLab Duo Coffee Chat: Herausforderung – Shell-Skripte refaktorisieren zeigt ein Beispiel mit einem C-Programm, das Syslog-Dateien bearbeiten kann, und einem in Bash geschriebenen Build-Skript. Während der gesamten Challenge wird der Chat mit den Prompts /explain
und /refactor
abgefragt, um den Code zu verbessern. Es ist auch möglich, Bash in POSIX-konformes SH oder ZSH zu refaktorisieren. Die Sitzung endet mit der Bitte an den Chat, fünf verschiedene Shell-Skriptimplementierungen bereitzustellen und die wichtigsten Zusammenfassungen zu erläutern.
Weitere Anwendungsfälle und Tutorials
- Dokumentation: GitLab-Duo-Anwendungsfälle
- Tutorial: Top-Tipps für effiziente KI-basierte Codevorschläge mit GitLab Duo
- Tutorial: 10 Best Practices für den Einsatz des KI-basierten GitLab Duo Chat
Wichtigste Erkenntnisse
- GitLab Duo bietet effiziente Hilfe beim Erklären und Refaktorisieren von Code.
- Du kannst Code zwischen den Sprachstandards refaktorisieren und im Chat weitere Fragen stellen.
- Prompts für Codevorschläge können bestimmte Sprachstandards generieren, und die Code-Vervollständigung geht auf den aktuellen Codekontext ein.
- Das Refaktorisieren von Code in neue Programmiersprachen hilft bei längerfristigen Migrations- und Modernisierungsvorhaben.
- Code kann auf die unterstützten Sprachstandards älterer Systeme „herabgestuft“ werden.
- GitLab Duo kann komplexe Code- und Programmiersprachen mit Beispielen in verschiedenen Programmiersprachen erklären.
- Das Update auf Anthropic Claude 3.5 auf GitLab.com hat die Qualität und Geschwindigkeit der Codevorschläge und des Chats noch einmal verbessert (Self-Managed-Upgrade auf 17.3 empfohlen).
- Es gibt keine Grenzen, außer deiner Vorstellungskraft und deinen Produktionsschwierigkeiten.
Erfahre mehr über effiziente Codevorschläge und Chat-Workflows und beginne jetzt deine KI-basierte Code-Refactoring-Reise mit GitLab Duo!
Starte deine 60-tägige kostenlose Testversion von GitLab Duo!