Django-rest-framework: etagを簡単に追加/検証します。

さて、私は予備パッチを持っています： //github.com/schinckel/django-rest-framework/commit/cc3a88edc6be21347a9b35929d158b8831ba9bd3

ただし、これに関するフィードバックには非常に満足しています。

さて、最初に私が書いたのはこれでした…。

かっこいい、ええ、私は本当にこれをで見たいです。

Couplaの考え-現在使用しているView._ETAGではなく、View.add_headerを使用できるはずです。
（そして、.add_headerはおそらくResponseMixinクラスに移動する必要があるようです。）

次に、 @ condition 、 @ etag 、 @ last_modifiedのデコレートが、 https：//github.com/django/django/blob/master/django/views/decoratorsのほぼ真っ直ぐなクローンになることを確認したいと思い

しかし、もう少し物事を調べていました...

そして、おそらくこれは結局のところ完全に正しい方法ではありません...

実際には、RESTフレームワークビューからHttpResponseを返すことができますが、通常のコンテンツネゴシエーション/シリアル化のすべてが適用されるわけではありません。 @last_modified 、 @etag 、および@conditionデコレータは、空のHttpResponseのみを返すため、実際には問題にはなりません。

つまり、私が考えているのは、単に__setitem__ __getitem__とhas_headerをResponseクラスに追加した場合、Djangoの既存の@last_modifiedだと思います。 @etagと@conditionビューが使用しているas_デコレータが_so長いRESTフレームワークビューでうまく動作するはずですreturn Response(status, data)ではなく、スタイルreturn dataスタイルを。

それを文書化すると便利ですが、Djangoがすでに行っていることを複製するよりも理にかなっているかもしれません。

どう思いますか？

djangoデコレータの使用には、問題が1つある可能性があります。メソッドで機能するかどうかはわかりませんが、関数はむき出しです。 私が書いたデコレータは、この場合のためにStackOverflowで見つけたデコレータに大きく基づいています。

そうではない場合もありますが、その場合、このソリューションの方が優れているように思われます。

そうは言っても、ボイラープレートが少ないため、戻りデータスタイルを返してきました。通常、jsonとしてシリアル化するオブジェクトのみを返します。 両方の方法で機能させることができるかもしれません。

別のオプションは、これらをViewクラスに追加するミックスインです。

また、djangoデコレータは、条件付きのPUT、POST、およびDELETE要求に関して正しいことを行わない可能性があることも私には思い浮かびます。 その問題を修正するためにsinatraにパッチを送信しました。

最後のビットを無視してください：明らかに私はコードを正しく読んでいませんでした。

実際には、そこにポイントがあります。これらのデコレータは、追加の「self」引数を持っているため、_methods_でATMを機能させない可能性があります。 私はそれを調べて、Djangoにチケットを提出する可能性があります。彼らもCBVと連携する必要があるからです...

ああ、わかりました- @ method_decoratorが表示されます... https：//docs.djangoproject.com/en/dev/topics/class-based-views/#decorating -class -based-views
だから私はこれを閉じるためにこれが必要だと思います：

1. 応答を少し調整する
2. いくつかの軽いドキュメント

そのドキュメントを調べたと思いますが、そのデコレータは見つかりませんでした。

djangoデコレータを使用しようとしましたが、最初の結果は非常に奇妙で、関連のないetag関数に表示されるビューにのみ属するはずの情報が含まれていました。

それを少し良くしようと数時間後、私は自分の問題を解決し、十分に一般的であるように見える解決策を思いつきました。 これについてどう思いますか：

https://bitbucket.org/vitormazzi/django-rest-framework/changeset/6f8de4500c6f

2.xリリースを開始した今、この問題に新たな息吹を吹き込むことを望んでいます。

ここでの私の考えは、プロジェクトに機能を追加しようとすることと、この投稿を読む

DRFがETagを考慮する必要がある2つの領域、つまりビューでの使用法と、インスタンスのバージョンの一意の表現を取得する方法がわかります。

ビュー

得る
GETリクエストは、適切なヘッダーでオブジェクトETagを提供する必要があります。 RetrieveModelMixinへの1行の変更で、これを簡単に追加できます。

def retrieve(self, request, *args, **kwargs):
    self.object = self.get_object()
    serializer = self.get_serializer(self.object)
    headers = {'ETag': self.object.etag}
    return Response(serializer.data, headers=headers)

PUT、PATCH、DELETE
HTTP動詞を更新するための一般的なチェックは、ビューのdispatchするか、ETagがオンになっているかどうかをチェックする必要があるため、別のメソッドにプルアウトすることができます（以下のオプションセクションを参照）。

    header_etag = request.META.get('HTTP_IF_MATCH')
    if header_etag is None:
        return Response({'error': 'IF_MATCH header is required'}, status=400)

次に、オブジェクトを取得した後のより詳細なチェックで、リクエストが正しいオブジェクトを参照していると見なすかどうかを確認します。

    if self.object.etag != header_etag:
        return Response({'error': 'object has been updated since you last saw it'}, status=412)

インスタンスバージョンの一意の表現

オブジェクトのETagの実際の生成がDRFの問題になるとは思わない。 オブジェクトのupdatedフィールドのエポック時間を使用してテストしてきましたが、もっと複雑にする必要があることが簡単にわかりました。

DRFはデフォルトでobj.etag検索することを提案しますが、通常のCBVフロー（ get_etag()やetag_var = 'get_my_objects_etag'を使用して構成できます。

また、ヘッダーと比較してタイプを解釈しようとすると、せいぜい苦痛になるため、ETagがオブジェクトから文字列として取得されるようにする必要があります。

オプション

• ETagの使用をオンまたはオフにするグローバル設定（シリアライザーなどと同様）。
• ビューの2つの設定：
  
  
  
  • use_etags （または同様のもの）-ブール値
  
  
  • etag_var -問題のオブジェクトに対してgetattrできる関数名の文字列
  
  

@ ghickman -ETagとLastModifiedを決定するための動作が、他のプラグ可能なクラスと同じように見えるようにしたいと思います。 つまり。 次のようなものがあります：

class MyView(views.APIView):
    cache_lookup_classes = []

署名のキャッシュはETagとLastModifiedの両方を処理する必要があり、提供したい2つの異なるものがあります。

• オブジェクトインスタンスを指定して、etagおよび/または最終変更を決定します。
• 着信リクエストを指定して、etagおよび/または最終変更をプリエンプティブに決定します。

BaseCacheLookup 、次のような2つのメソッドシグネチャがあります。

.object_etag_and_last_modified(self, view, obj)
.preemptive_etag_and_last_modified(self, view, request, *view_kwargs, **view_kwargs)

オブジェクトが(etag, last modified) 2つのタプルを返すとすると、どちらも単純になしになる可能性があります。
着信要求に一致するIf-Modified-SinceまたはIf-None-Matchヘッダーが含まれている場合、304 NotModified応答が返されます。 着信応答に一致するIf-MatchまたはIf-Unmodified-Sinceが含まれている場合、412 PreconditionFailed応答が返されます。

これにより、説明した実装に一致するCacheLookupClassだけでなく、他のバリアントも許可されます。

たとえば、最後に変更された粒度が異なる複数のキャッシュルックアップクラスを適用することもできます。
含めるGlobalLastModifiedLookupに加えて、 ObjectETagLookup 。 これにより、キャッシュされたコピー以降に書き込みが行われなかった場合に、データベース呼び出しを行う前にビューがプリエンプティブに戻ることができます。 （Varnishでサーバー側のキャッシュを使用している場合、そのような本当に基本的なポリシーでさえ、大きな違いを生む可能性があります）

このプラグイン可能なクラス側はあなたにとって合理的ですか？

現在の実装ではLastModifiedを使用していないため、LastModifiedについては考えていませんでしたが、目的を考えれば、LastModifiedを含めることは間違いなく理にかなっています。

特にLastModifiedとETagの実装を基本的な例として含める場合、プラグイン可能なクラスは素晴らしいアイデアのように聞こえます。 プロジェクトに最小限の変更を加えるだけで、GETキャッシュを非常に簡単にオンにできるという考えが気に入っています。

私は、etagとlast_modifiedの生成を（それらの名前の）2つのメソッドに分割したいと思います。あなたが提案したように、実装されていない場合はNone返します。 次に、CacheLookupバックエンドは、一方または他方の実装を選択できます。 便利だと思われる場合は、2つを組み合わせた便利なユーティリティメソッド（ cachable_obj_reprまたはunique_obj_reprかもしれませんか？）をいつでも提供できます。

tl; drはい、プラガブルクラス側は合理的に聞こえ、はるかに高い柔軟性を提供するはずです。 このためのパッチを書き始めてうれしいです。

こんにちは、みんな。 興味があれば、拡張機能ライブラリhttp://chibisov.github.io/drf-extensions/docs/にetagサポートのさまざまなアプローチを実装しました。

@chibisovNeato 。 私たちは本当に＃1019を終えるべきなので、このようなパッケージにリンクするためのドキュメントのどこかにあります。

＃1019が閉じられ、 @ chibisovのパッケージがリストされているためこれを閉じます。

これは、ある時点で正式な指示を与えたいので、意図的に3.3としてマイルストーンされました。 これを閉じたままにすることを選択したかどうかについてはあまり心配していませんが、それは私の内部ロードマップにあります。

残念ながら、drf-extensionsのEtag機能に関するデフォルトの実装とドキュメントは単に間違っており、危険なほどバグがあります。 _response_が変更された場合ではなく、_request_が変更された場合にEtagが変更されます。 これはまさにサーバーサイドキャッシングに必要なものであり、Etagには必要ないものです。

@mboxは、drf-extensionsでこれに関する問題を開くか、DRFの「コア」問題であると思われる場合はここで開くのが最善です。 失敗したテストは、問題を調べるための良いスタートになることに注意してください。

@mbox @xordoquy
DRF APIを介してリソースを操作するための楽観的同時実行制御を可能にするPRをdrf-extensions（https://github.com/chibisov/drf-extensions/pull/171）に送信しました。 すべてのオブジェクトフィールドのセマンティックハッシュを使用しており、デモンストレーション用にテストアプリを含めました。 Python 2.7、3.4、3.5を使用して、DRF> = 3.3.1およびdjango> = 1.8に対してテストされています。

ありがとう

将来の読者へのメモ-Djangoの条件付きデコレータをDRFと一緒に使用するための小さなパッケージを作成しました。 したがって、興味がある場合：
https://github.com/jozo/django-rest-framework-condition