OLD | NEW |
---|---|
1 // Copyright 2015 The Chromium Authors. All rights reserved. | 1 // Copyright 2015 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 package datastore | 5 package datastore |
6 | 6 |
7 import ( | 7 import ( |
8 "fmt" | |
8 "reflect" | 9 "reflect" |
9 ) | 10 ) |
10 | 11 |
11 // GetPLS resolves obj into default struct PropertyLoadSaver and | 12 // GetPLS resolves obj into default struct PropertyLoadSaver and |
12 // MetaGetterSetter implementation. | 13 // MetaGetterSetter implementation. |
13 // | 14 // |
14 // obj must be a non-nil pointer to a struct of some sort. | 15 // obj must be a non-nil pointer to a struct of some sort. |
15 // | 16 // |
16 // By default, exported fields will be serialized to/from the datastore. If the | 17 // By default, exported fields will be serialized to/from the datastore. If the |
17 // field is not exported, it will be skipped by the serialization routines. | 18 // field is not exported, it will be skipped by the serialization routines. |
18 // | 19 // |
19 // If a field is of a non-supported type (see Property for the list of supported | 20 // If a field is of a non-supported type (see Property for the list of supported |
20 // property types), the resulting PropertyLoadSaver will have a non-nil | 21 // property types), this function will panic. Other problems include duplicate |
21 // Problem(). Other problems include duplicate field names (due to tagging), | 22 // field names (due to tagging), recursively defined structs, nested structures |
22 // recursively defined structs, nested structures with multiple slices (e.g. | 23 // with multiple slices (e.g. slices of slices, either directly `[][]type` or |
23 // slices of slices, either directly `[][]type` or indirectly `[]Embedded` where | 24 // indirectly `[]Embedded` where Embedded contains a slice.) |
24 // Embedded contains a slice.) | |
25 // | 25 // |
26 // GetPLS supports the following struct tag syntax: | 26 // GetPLS supports the following struct tag syntax: |
27 // `gae:"fieldName[,noindex]"` -- an alternate fieldname for an exportable | 27 // `gae:"fieldName[,noindex]"` -- an alternate fieldname for an exportable |
28 // field. When the struct is serialized or deserialized, fieldName will be | 28 // field. When the struct is serialized or deserialized, fieldName will be |
29 // associated with the struct field instead of the field's Go name. This is | 29 // associated with the struct field instead of the field's Go name. This is |
30 // useful when writing Go code which interfaces with appengine code written | 30 // useful when writing Go code which interfaces with appengine code written |
31 // in other languages (like python) which use lowercase as their default | 31 // in other languages (like python) which use lowercase as their default |
32 // datastore field names. | 32 // datastore field names. |
33 // | 33 // |
34 // A fieldName of "-" means that gae will ignore the field for all | 34 // A fieldName of "-" means that gae will ignore the field for all |
(...skipping 118 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
153 // } | 153 // } |
154 // | 154 // |
155 // type Person struct { | 155 // type Person struct { |
156 // Name `gae:"$id"` | 156 // Name `gae:"$id"` |
157 // } | 157 // } |
158 func GetPLS(obj interface{}) interface { | 158 func GetPLS(obj interface{}) interface { |
159 PropertyLoadSaver | 159 PropertyLoadSaver |
160 MetaGetterSetter | 160 MetaGetterSetter |
161 } { | 161 } { |
162 v := reflect.ValueOf(obj) | 162 v := reflect.ValueOf(obj) |
163 if !v.IsValid() { | |
164 panic(fmt.Errorf("cannot GetPLS(%T): failed to reflect", obj)) | |
165 } | |
163 if v.Kind() != reflect.Ptr || v.Elem().Kind() != reflect.Struct { | 166 if v.Kind() != reflect.Ptr || v.Elem().Kind() != reflect.Struct { |
164 » » return &structPLS{c: &structCodec{problem: ErrInvalidEntityType} } | 167 » » panic(fmt.Errorf("cannot GetPLS(%T): not a pointer-to-struct", o bj)) |
165 } | 168 } |
166 if v.IsNil() { | 169 if v.IsNil() { |
167 » » return &structPLS{c: &structCodec{problem: ErrInvalidEntityType} } | 170 » » panic(fmt.Errorf("cannot GetPLS(%T): pointer-to-struct is nil", obj)) |
168 } | 171 } |
169 v = v.Elem() | 172 v = v.Elem() |
170 c := getCodec(v.Type()) | 173 c := getCodec(v.Type()) |
171 return &structPLS{v, c} | 174 return &structPLS{v, c} |
172 } | 175 } |
173 | 176 |
174 func getMGS(obj interface{}) MetaGetterSetter { | 177 func getMGS(obj interface{}) MetaGetterSetter { |
175 if mgs, ok := obj.(MetaGetterSetter); ok { | 178 if mgs, ok := obj.(MetaGetterSetter); ok { |
176 return mgs | 179 return mgs |
177 } | 180 } |
178 return GetPLS(obj) | 181 return GetPLS(obj) |
179 } | 182 } |
180 | 183 |
181 func getCodec(structType reflect.Type) *structCodec { | 184 func getCodec(structType reflect.Type) *structCodec { |
182 structCodecsMutex.RLock() | 185 structCodecsMutex.RLock() |
183 c, ok := structCodecs[structType] | 186 c, ok := structCodecs[structType] |
184 structCodecsMutex.RUnlock() | 187 structCodecsMutex.RUnlock() |
185 » if ok { | 188 » if !ok { |
186 » » return c | 189 » » structCodecsMutex.Lock() |
190 » » defer structCodecsMutex.Unlock() | |
191 » » c = getStructCodecLocked(structType) | |
187 } | 192 } |
188 | 193 » if c.problem != nil { |
dnj
2015/12/12 04:04:53
IMO: While I find the effort to avoid recomputing
| |
189 » structCodecsMutex.Lock() | 194 » » panic(c.problem) |
190 » defer structCodecsMutex.Unlock() | 195 » } |
191 » return getStructCodecLocked(structType) | 196 » return c |
192 } | 197 } |
OLD | NEW |