Verwendet d-String-Mixine, um Code wiederzuverwenden, ein Anti-Muster wiederverwendet?

Question

Für diejenigen von Ihnen, die mit D-String-Mixins nicht vertraut sind, sind sie grundsätzlich kompilierdauer Evals. Sie können eine beliebige Kompilierzeit-Zeichenfolge (egal ob ein wörtliches oder durch TEMPLATE-METAPROGRAMING- oder Kompilierzeit-Funktionsbewertung) annehmen und als Code kompilieren. Wenn Sie ein einfaches Zeichenfolgen-Literal verwenden, ist es im Wesentlichen auf Compiler-automatisierte Copy-Paste.

Würden Sie es in Betracht ziehen, dass ein Antipatentrum, um String-Mixins von Literalen als Mittel zur einfachen Code-Wiederverwendung zu verwenden, wo andere Factoring-Methoden nicht recht passen? Einerseits ist es im Wesentlichen auf Compiler-automatisierte wörtliche Kopier- und Paste, was bedeutet, dass einst in den Fällen gemischt, dass nichts miteinander nichts zu tun hat. Schlechte Dinge werden passieren (wenn auch zur Kompilierzeit, nicht zur Laufzeit), wenn ein Symbol in der Zeichenfolge Mixin mit einem Symbol im gemischten Umfang kollidiert. Es ist relativ unstrukturiert, dass man beispielsweise eine Zeichenfolge in die Mitte einer Funktion mischen kann, die funktioniert, wenn und nur, wenn Variablen im Rahmen eines bestimmten Übereinkommens benannt werden. Mixins können auch Variablen deklarieren, dass die äußeren Scopes dann verwenden können, wenn sie passen.

Andererseits, da die Kopier- und Paste Compiler automatisiert ist, gibt es einen einzelnen Punkt der Wahrheit für den fraglichen Code auf Quellstufe, und wenn es modifiziert werden muss, muss es nur modifiziert werden Ein Ort, und alles bleibt synchron. String-Mixine vereinfachen auch den Wiederverwendungscode, der sehr schwer ist, auf andere Weise zu fördern, und hätte sonst eine sehr hohe Wahrscheinlichkeit, dass sie manuell gesenkt werden würde.

Answer 1

Alle Kritik, die Sie aufgewachsen sind, sind wahr.

Unabhängig davon ist es dem manuellen copypaste noch überlegen.

Ich habe tatsächlich etwas Ähnliches in meiner Expansion in meiner Werkzeugbibliothek, String-Tabelle.Beispielcode, von der dynamischen Wert-Implementierung von Path Tracer:

generasacodicetagpre.

Ich bin sicher, es ist leicht zu sehen, was ein schreckliches, redundantes Durcheinander verschachtelter When- und Fallaussagen, das ohne String-Mixins sein würde - auf diese Weise, dass die gesamte Hässlichkeit an der Unterseite konzentriert ist, und das tatsächliche -Verfahren der Funktion ist leicht, auf einen Blick abzulesen.

Answer 2

While other, more elegant solutions may be better to use if you can, string mixins can be extremely useful. They allow for both code re-use and code generation. They're checked at compile time. The code that results is exactly the same as if you'de written it yourself by hand, so it's not any less safe than if you had written it yourself by hand.

The problem with string mixins is that they're harder to control than hand-written code in the sense that it's not physically laid out in your source in the same manner with line numbers clearly traceable to errors, and it may be harder to debug. For instance, take hello world with a string mixin:

import std.stdio;

void main()
{
    mixin(hello());
}

string hello()
{
    return "
    writeln(\"hello world\");
";
}

If we were to remove the semicolon after writeln(), then the error we got would be

d.d(7): found 'EOF' when expecting ';' following statement

The mixin is done on line 5. Line 7 is a blank line. So, the line number is of limited usefulness here. Now, this mixin is short enough that we could have put it on a single line and gotten it to say that the error was on the same line as the mixin, but with more complicated mixins, that obviously won't work. So, by using a string mixin, your ability to figure out where an error is is impaired. If the code is generated using CTFE, then it would become that much more difficult to figure out exactly what the code even looks like in order to figure out what's wrong with it. It's a lot like figuring out what code a C-style macro turns into, except that it could be worse because they could be generated rather than a direct replacement. However, they don't replace except where you explicitly tell them to, so they're much safer than C-style macros.

String mixins are totally safe, and there's nothing particularly wrong with them, but they do make maintenance harder in some ways. The corresponding hand-written code would be easier to debug. However, string mixins are powerful enough that they can do a lot of code generation for you and save you a lot of maintainence costs in that sense, and they allow you to re-use code, which can be a big maintanence gain as well.

So, whether using a string mixin is a good idea in a particular situation depends on that situation. I don't see anything particularly wrong with them, and I certainly wouldn't call them an anti-pattern, but there are both pros and cons to using them such that whether they're a good idea depends on what you're doing. In many cases, there are more elegant, cleaner solutions which would be better. In others, they're exactly what the doctor ordered.

Personally, I think that they're fantastic if you're looking to generate code, saving yourself the effort of having to write that code by hand, and possibly making it easier to generate correct code for a variety of situations and avoiding risking creating new bugs like you might have had you written it yourself in each of those places where you used the mixin. It also is one of the ways to just outright re-use code without having to worry about the cost of a function call or issues with the limits of single-inheritance or anything else that makes code re-use by calling functions or inheritance harder. You're simply copying and pasting the code into each place in a manner which makes it so that if you change the code, the changes will be properly pasted everywhere without you having to worry about tracking them all down like if you had hand copy and pasted.

So, use string mixins where appropriate, and it's probably best not to use them if they're not needed, but there's nothing really wrong with using them.

Answer 3

String mixin is like goto: it should be avoided where ever possible and should be used wherever required.